Skip to content

Jobs

In an AskAnna project, you can create jobs that you specify in the askanna.yml. Jobs described as tasks you want to perform using AskAnna.

There are a couple of use cases for jobs in AskAnna:

  1. Run a (large) task in AskAnna, so you don’t have to run it locally on your machine
  2. If you want to run a series of commands, for example to retrain & update your model, the job is the place to be
  3. Using our API and Jobs, you can put a data science model in production and run it via other applications

Job overview

Jobs relates to a project. On the project page you will find a section listing jobs.

Jobs

When you open the jobs section, you will find a table that lists the available jobs for that project. In this table you will find:

Name Description
If you click on this arrow, a list of runs for this job opens
Name Name of the job
Runs How many times the jobs has run
Status The status of the last run

You can find more details about the table with runs on the runs page.

Job page

After you have created a job, you can open the job page related to that job. On this page you will find the Overview with:

  • Description of the job
  • Definition of the job
  • Information how you can run the job

Also, you see a section Runs where you can find the runs for that job. On the run documentation you can find more information regarding this topic.

Below an example of a job page:

Job page

Edit job info

Via the web interface, you can edit the information of the job. In addition, via the CLI and Python SDK, you can update the description and change the job's name as well.

Changed the job name? Then update the askanna.yml as well.

Changing the name of a job can be useful in case you want to rename your job. If you are going to rename the job, don't forget to rename the job in the askanna.yml.

If you don't do this, you will not be able to run the job anymore because there is no matching job definition in the askanna.yml config. And if you don't change it in the askanna.yml file, the next time you push a new version of your code to AskAnna we will create a new job using the old name.

Web interface

On the job page you can click on . In this menu select EDIT JOB and you can update the job info. Here you can also add or update a description of the job. Everybody with access to the job can see this information.

Edit job info

Markdown support

The text editor support Markdown instructions. These instructions will automatically transferred into formatted text.

CLI

With the AskAnna CLI you can change the job info with your command line. In your terminal run:

askanna job change

Optionally you can also directly provide the info you want to change. For example, if you only want to change the name, you don't have to specify the description. If you don't add it, it will not be updated.

askanna job change --id "JOB SUUID" --name "New job name" --description "Updated description"

Python SDK

With the AskAnna Python SDK, you can change the job info using the SUUID of the job:

from askanna import job

job_suuid = "JOB SUUID"  # required
new_name = "New job name"  # need name, description or both
new_description = "Updated description for the job"  # need name, description or both

job.change(job_suuid=job_suuid, name=new_name, description=new_description)

Remove a job

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

When you remove a job, this it what happens:

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

Recovery period of 30 days

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

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