Skip to content

Runs

A central component in data science projects is the runs of a job. In AskAnna you can track all relevant information related to a run. For example you can track input, metrics, parameters, code version, artifacts and results. If you want to track something, and we currently don't support it, contact ([email protected]) us.

The information you track in a run can be used for later comparison. In the phase of experimentation you can compare runs and see which settings will perform the best. Or in production phase you can monitor the stability of the model over time. Via AskAnna you can easily extract/query the project information and build your own dashboards to get insights from your runs.

Run overview

The current runs are related to jobs. You can find them on two locations in the project. The first location is on the project page in the section Jobs. Here the jobs for that project are listed and via the you can expand a section that will list the runs related to that job.

The second location is on the job page in the section Runs. On both locations you will find a table like the screenshot below.

Run overview

In this table you find:

Name Description
SUUID The first four charactes of the run SUUID. If you put your mouse on the text you can also see the full SUUID and a copy button to copy the full SUUID.
Name If a name was set for the run, we show the name. If no name is set, we show an empty cell.
Status The status of the run
Timing Information when the run started and what the duration was/is (depending on the status)
By The member who triggered the run
Input The number of lines the input payload file has. When the payload is empty, it is reported as 1 line.
Metrics The number of metrics tracked for the run

When you click on a run, the related run page will open. If you click on any object on the row, the run page will open. But if you specifically click on the input or metrics, we will directly open the tab INPUT or METRICS on the related run page.

Run page

On the run page we list all information related to the run. Here you can find the meta information of the run, the input, results, metrics, artifact, variables, code and logs. An example of the run page:

Run page

When you open the run page, you will see:

  • Title with name (if set) or SUUID of the run
  • Navigation bar with tabs

In the navigation bar you find the next tabs:

Tab Description
Overview Meta information of the run
Input The input used for the run
Result The result for the run
Metrics The metrics tracked for the run
Artifact Saved files and directories for the run
Code The code version used on this run
Variables The variables tracked by the run and set in the run environment
Log The log (console output) of the run
Menu with additional options for the run

On the tab OVERVIEW you can find the following meta-information about the run:

Name Description
Status Status of the run
SUUID SUUID of the run
Job Name of the job used for this run
Start date Date the run started
Duration Duration of the run
Code Version of the code used for this run
By Member who triggered the run
Trigger How the run was triggered
Environment Environment/image used for the run

For input we only support the JSON payload (for now). In both the payload and the result we assume that this is a JSON file. In the section you can see the content of the file. Also there is an option to download the file or copy the content of the file.

In the log section you can find the console output of the run environment. By default we load the first 100 lines, and when you have a larger log it will automatically load more lines when you scroll trough the log. Also you can download or copy the content of the log.

Starting a run

Check the jobs documentation to read about How to run a job. Here you can find the information about how to run a job using the:

Retrieving run data via the AskAnna CLI, SDK & API

The information that we show on the run page can always be retrieved via the AskAnna API and in most cases also the AskAnna CLI. The only relevant information you need to know is the SUUID of the run. You can find the SUUID of the run on the run page or you can copy the SUUID from the run overview.

Get Payload

AskAnna CLI:

askanna-run-utils get-payload --jobrun "RUN SUUID"

Optionally you can also specify the output path via --output.

AskAnna API:

curl -X GET \
-H 'Authorization: Token {{ YOUR TOKEN }}' \
'https://beta-api.askanna.eu/v1/jobrun/{{ RUN SUUID }}/payload/'

Get Result

AskAnna CLI:

askanna result get --id "RUN SUUID"

Python SDK:

from askanna import result

result = result.get(run_suuid="RUN SUUID")

AskAnna API:

curl -X GET \
-H 'Authorization: Token {{ YOUR TOKEN }}' \
'https://beta-api.askanna.eu/v1/result/{{ RUN SUUID }}/'

Get Metrics

AskAnna SDK:

from askanna import metrics

run_metrics = metrics.get(run="RUN SUUID")

AskAnna API:

curl -X GET \
-H 'Authorization: Token {{ YOUR TOKEN }}' \
'https://beta-api.askanna.eu/v1/runinfo/{{ RUN SUUID }}/metrics/'

Get Artifact

AskAnna CLI:

askanna artifact get --id "RUN SUUID"

Optionally you can also specify the output path via --output.

AskAnna API:

curl -X GET \
-H 'Authorization: Token {{ YOUR TOKEN }}' \
'https://beta-api.askanna.eu/v1/artifact/{{ RUN SUUID }}/'

Get Variables

AskAnna API:

curl -X GET \
-H 'Authorization: Token {{ YOUR TOKEN }}' \
'https://beta-api.askanna.eu/v1/runinfo/{{ RUN SUUID }}/variables/'

Get Log

AskAnna API:

curl -X GET \
-H 'Authorization: Token {{ YOUR TOKEN }}' \
'https://beta-api.askanna.eu/v1/runinfo/{{ RUN SUUID }}/log/'

Edit run info

AskAnna is designed to empower you to reproduce results. Most of the information of a run cannot be edited. Exception is the name and description of the run.

To edit the name and description of the run, on the run page you can click on . In this menu select EDIT RUN INFO and a form to edit the run info opens. Save your changes, and you are done.

AskAnna Run - Edit info

Run failures

It can happen that a run fails. When this happens, AskAnna will always try to save the latest log and the specified artifact of the run. Because the run was not succesfull, we will not save a result for the run.

In case something went wrong with running your code, you can probably find information about the error in the run log. Our jobs run in containers, and we keep them for 24 hours. So in case the logs doesn't help you to figure out what went wrong, you can always contact us ([email protected]). With your permission we can check the container used for the run and see if we can help you.

Remove a run

In the web interface you can remove a run via the run page. Click on at the right side. Then click on Remove this run.

When you remove a run, this it what happens:

  • the run will be removed
  • all data related to the run will be removed
  • if other projects, systems or jobs use information or files from the run, they are not able to use it anymore

Recovery period of 30 days

When you remove a run, you will not have access to the run anymore. After 30 days, the system will entirely delete the run from the backend. Within 30 days, you can contact us if you want to undo the removal.

If the run and related files should be removed as soon as possible, you can contact us.