askanna

AskAnna CLI & Python SDK

The AskAnna CLI offers a command line interface to the AskAnna platform. With the Python SDK you can run AskAnna functions directly from your Python script. The CLI & Python SDK simplifies the communication with the AskAnna platform and provides facilities for supporting every part of a data science project.

Documentation

For the latest information check the AskAnna Documentation. Or open directly the documentation for:

• Command line (CLI)
• Python SDK

Quickstart

Install AskAnna

pip install askanna

Update AskAnna

pip install -U askanna

Login to AskAnna

askanna login

This will create a .askanna.yml in your home directory.

Authorization token

When the AskAnna CLI & Python SDK is used in for example a CI/CD, one can configure authentication by setting an environment variable:

export AA_REMOTE=https://beta-api.askanna.eu
export AA_TOKEN={{ API TOKEN }}

The API token can be found in the created ~/.askanna.yml file after you logged in with askanna login.

How to push code to AskAnna

Run the innit-command on the main directory of your project. The command will create a new project on AskAnna and will add a askanna.yml file to your local project directory. In the askanna.yml file you can configure jobs. For more information, see the askanna.yml documentation.

askanna init

If you want to start a project from scratch (or a template), you can run the create-command.

askanna create

With the push-command your code will be uploaded to the project in AskAnna.

askanna push

Track metrics

To track metrics for your runs, you can use the function track_metric. For more information, see the metrics documentation.

from askanna import track_metric

track_metric("name", "value")

Track variables

To track variables for your runs, you can use the function track_variable. For more information, see the variables documentation.

from askanna import track_variable

track_variable("name", "value")