search

thoth-station / thamos

A CLI tool and library for communicating with Thoth
http://thoth-station.ninja
GNU General Public License v3.0
15 stars 17 forks source link
artificial-intelligence commandline hacktoberfest thoth

readme

Thamos

.. image:: https://img.shields.io/github/v/tag/thoth-station/thamos?style=plastic :target: https://github.com/thoth-station/thamos/releases :alt: GitHub tag (latest by date)

.. image:: https://img.shields.io/pypi/v/thamos?style=plastic :target: https://pypi.org/project/thamos :alt: PyPI - Module Version

.. image:: https://img.shields.io/pypi/l/thamos?style=plastic :target: https://pypi.org/project/thamos :alt: PyPI - License

.. image:: https://img.shields.io/pypi/dm/thamos?style=plastic :target: https://pypi.org/project/thamos :alt: PyPI - Downloads

A CLI tool and library for communicating with Thoth backend.

Using Thamos as a CLI tool

Thamos is released on PyPI <https://pypi.org/project/thamos>_. See installation instructions bellow to setup Thoth/Thamos for your repository:

.. code-block:: console

Install Thamos CLI tool:

$ pip3 install thamos # keep in mind: requires Python 3.6+!!

Go to repository that should be managed by Thoth which already has Pipfile present:

$ cd ~/git/repo/

Setup Thamos configuration:

$ thamos config

Add packages.

$ thamos add tensorflow

Ask Thoth for software stack recommendations:

$ thamos advise

Install packages:

$ thamos install # can be merged using thamos advise --install

Retrieve logs of the last analysis:

$ thamos log

As Thamos notes analysis ids for better UX of thamos log, it's recommended to add .thoth_last_analysis_id file to .gitignore. Adding also .venv might be useful if virtual environment management is turned on.

See thoth-station/cli-examples <https://github.com/thoth-station/cli-examples>__ repository with examples.

Recommendation types

See this document <https://thoth-station.ninja/recommendation-types/>__ for a detailed info on the recommendation types Thoth provides.

Adjusting configuration based on environment variables

You can adjust content of configuration file each time Thamos CLI or Thamos library loads it by expanding entries with environment variables. This can be handy if you would like to parameterize some of the options at runtime (e.g. in deployment).

This behaviour is (due to security reasons) explicitly turned off by default. However you can turn it on by setting THAMOS_CONFIG_EXPAND_ENV environment variable to 1 (0 explicitly turns this behaviour off, default value):

.. code-block:: console

THOTH_HOST=test.thoth-station.ninja THAMOS_CONFIG_EXPAND_ENV=1 thamos advise
2019-03-13 11:22:59,562 [18639] INFO     thamos.config: Expanding configuration file based on environment variables

Entries which should be expanded have environment variables in curly braces like the following example:

.. code-block:: yaml

host: {THOTH_HOST}

Note the expansion is done by replacing these values directly with values of environment variable, this means types need to be taken into account (environment variable with value "true" is put into configuration file as true).

Using custom configuration file template

You can use your own custom configuration file as a template. This is especially useful if you want to have some configuration entries constant and let expand only some of the configuration options. In other words, you can parametrize configuration file.

An example of configuration file template can be:

.. code-block:: yaml

host: {THOTH_SERVICE_HOST} tls_verify: true requirements_format: {requirements_format}

runtime_environments:

Then, you need to supply this configuration file to the following command:

.. code-block:: console

thamos config --template template.yaml

Listing of automatically expanded configuration options which are supplied the config sub-command (these options are optional and will be expanded based on HW or SW discovery):

+-----------------------------+--------------------------------+---------------------------------------------------+ | Configuration option | Explanation | Example | +=============================+================================+===================================================+ | runtime_environment_name | name of operating system | fedora-35 | +-----------------------------+--------------------------------+---------------------------------------------------+ | os_name | name of operating system | fedora | +-----------------------------+--------------------------------+---------------------------------------------------+ | os_version | version of operating system | 35 | +-----------------------------+--------------------------------+---------------------------------------------------+ | cpu_family | CPU family identifier | 6 | +-----------------------------+--------------------------------+---------------------------------------------------+ | cpu_model | CPU model identifier | 94 | +-----------------------------+--------------------------------+---------------------------------------------------+ | python_version | Python version (major.minor) | 3.10 | +-----------------------------+--------------------------------+---------------------------------------------------+ | cuda_version | CUDA version (major.minor) | 11.1 | +-----------------------------+--------------------------------+---------------------------------------------------+ | platform | Platform used. | linux-x86_64 | +-----------------------------+--------------------------------+---------------------------------------------------+ | requirements_format | Requirements format. | pipenv | +-----------------------------+--------------------------------+---------------------------------------------------+ | base_image | Thoth base image used. | quay.io/thoth-station/s2i-thoth-ubi8-py36:v1.0.0 | +-----------------------------+--------------------------------+---------------------------------------------------+

Platform corresponds to sysconfig.get_platform() call.

These configuration options are optional and can be mixed with adjustment based on environment variables (see THOTH_SERVICE_HOST example above). Note the environment variables are not expanded on thamos config call but rather on other sub-commands issued (e.g. thamos advise or others).

The output format coming out of recommendations can be compatible with Pipenv <https://pipenv.kennethreitz.org/en/latest/>__, raw pip <https://pip.pypa.io/en/stable/user_guide/> or similar to the one provided by pip-tools <https://pypi.org/project/pip-tools/> (actually same as for pip as these formats are interchangeable). The format is configured using requirements_format configuration option, available options are:

Labels

It is possible to label requests for user-specific needs. In such a case, resolver will include pipeline units that match labels with the ones provided on the request.

An example can be a CI system that is asking for an advise and labels the request with requester=ci_foo;team=thoth. In such a case, the resolution engine includes pipeline units that are specific to the CI system and the team specified (besides the ones that are added by default). Labels can be specified in the .thoth.yaml configuration file or using CLI (labels passed via CLI take precedence):

.. code-block:: console

thamos advise --labels requester=ci_foo;team=thoth

See the following demo for more information <https://www.youtube.com/watch?v=eoJIfQip_6M>__.

Support for multiple runtime environments

Thoth performs recommendations based on your hardware and software environment, so called runtime environments. You can specify more than just one runtime environment that should be targetted during recommendations. This might be suitable if you would like to tweak some runtime environment specific configuration options. An example could be a deployment of a machine learning model to the cluster that uses CUDA, but you do not run CUDA locally (fast iterative development locally, subsequently training a model in the cluster on a large dataset). In such cases, you can specify two configuration entries in .thoth.yaml file:

.. code-block:: yaml

host: {THOTH_SERVICE_HOST} tls_verify: true requirements_format: pipenv

runtime_environments:

The two runtime environments stated in the .thoth.yaml differ in cuda_version configuration and their names.

To trigger advises for runtime environment named cuda, issue:

.. code-block:: console

thamos advise --runtime-environment cuda

To target the latter runtime environment named no_coda, you can issue:

.. code-block:: console

thamos advise --runtime-environment no_cuda

This option can be also supplied via environment variable using THAMOS_RUNTIME_ENVIRONMENT=no_cuda.

If the runtime environment is not provided explictly, Thamos will take the first runtime environment entry stated in the runtime_environment listing. For the example showed above it will default to cuda environment:

.. code-block:: console

defaults to the first one - "cuda"

thamos advise

Multiple runtime environments can be used in conjunction with the automatically expanded configuration options and configuration file templating naturally.

By default, all the files produced during advises are stored in the project root directory. To maintain multiple lock files specific for runtime environments, it is possible to configure "overlays" directory in Thamos configuration file.

Listing available environments and container images

To list available environments for which the resolver can resolve dependencies, issue:

.. code-block:: console

thamos environments

Each entry states configuration of operating system, its version and Python interpreter version that can be configured in each runtime environment section in .thoth.yaml.

If you wish to list available container images ready to be used:

.. code-block:: console

thamos images

Each entry stated can be set as a base_image in .thoth.yaml in the respective runtime environment section and used as a base for running the Python applications.

Overlays directory

Multiple directories carrying requirement files can be configured using overlays_dir configuration option in .thoth.yaml file. This configuration is configured on a global scope and all the runtime environments inherit path from it.

An example configuration file states overlays_dir:

.. code-block:: yaml

host: {THOTH_SERVICE_HOST} tls_verify: true requirements_format: pipenv overlays_dir: overlays

runtime_environments:

In such case, the directrory structure respecting the configuration supplied should be:

.. code-block:: console

. ├── app.py ├── overlays │   ├── fedora-33 │   │   ├── Pipfile │   │   ├── Pipfile.lock │   │   ├── .env │   │   └── constraints.txt │   └── ubi-8 │   │   ├── Pipfile │   │   ├── Pipfile.lock │   │   ├── .env │   │   └── constraints.txt └── .thoth.yaml

Each directory in the overlays directory should respect the runtime environment name stated in .thoth.yaml file and carries files specific for the given runtime environment.

Similarly as for Pipenv files, requirement files respecting pip-tools <https://pypi.org/project/pip-tools>__ can be used (requirements.in and requirements.txt).

Constraints files <https://thoth-station.ninja/docs/developers/adviser/experimental_features.html#constaints-files>__ (constraints.txt) are optional.

Optionally, users can provide .env file that can state environment variables that should be passed to the process when thamos run is executed. The .env file states each environment variable on a single line in a form of ENV_NAME=VALUE. Optionally, lines can be commented out with hash (#). An example of the file content:

.. code-block::

This is an example .env file.

FOO=bar ANOTHER_FOO=another_bar

Each .env file can be specified per overlay. If no overlay directories are used, .env file can be placed in the top level project directory (the directory where .thoth.yaml is present).

Installing requirements

Once a lock file is resolved after calling thamos advise, the application stack can be installed by using thamos install command. If you wish to pass additional options that should be used by pip, you can do so by passing them after --.

An example could be installing packages in a corporate network where packages should be installed through a proxy tunnel:

.. code-block:: console

thamos install -- --proxy socks5h://127.0.0.1:8029 --trusted-host pypi.org

Advise report structure

The structure of the advise report in JSON format produced with the thamos advise --json command is available in the Thoth API advise endpoint <https://khemenu.thoth-station.ninja/api/v1/ui/#/Advise/get_advise_python> to retrieve advise results and in the corresponding schema specification <https://github.com/thoth-station/user-api/blob/d81a54236f7dfe55d138ed1fe236eaf097a53d9a/openapi/openapi.yaml#L2741> for this endpoint.

Using Thoth and thamos in OpenShift's s2i

Using configuration templates is especially useful for OpenShift builds where you can specify your template in an s2i repository (omit Pipfile.lock to enable call to thamos advise as shown in this repository <https://github.com/thoth-station/s2i-example-tensorflow>_).

Then, you need to provide following environment variables:

See OpenShift s2i documentation <https://docs.openshift.com/container-platform/3.9/dev_guide/builds/advanced_build_operations.html#dev-guide-assigning-builds-to-nodes>_ on how to pin build to a specific node in the cluster. This is needed if you would like to perform automatic hardware discovery to get optimized stacks on your hardware.

Using Thamos as a library

.. code-block:: python

from thamos.lib import image_analysis from thamos.config import config

Set global context.

Host to Thoth's User API. API discovery will be done

transparently and the most appropriate API version will be used.

config.explicit_host = "khemenu.thoth-station.ninja"

TLS verification when communicating with Thoth API.

config.tls_verify = True

image_analysis( image="registry.redhat.com/fedora:29", registry_user="fridex", registry_password="secret!",

TLS verification when communicating with registry.

 verify_tls=True,
 nowait=False

)

Disabling TLS related warnings

If you communicate with Thoth's user API without TLS (you have set the tls_verify configuration option to false in the .thoth.yaml file), Thamos CLI and Thamos library issue a warning each time there is done communication with the API server. To suppress this warning, set the THAMOS_DISABLE_TLS_WARNING environment variable to a non-zero value:

.. code-block:: console

$ export THAMOS_DISABLE_TLS_WARNING=1 $ thamos advise

Autogenerated client from OpenAPI

Most parts of Thamos consist of automatic generated code. You can update Thamos by running the following command:

.. code-block:: console

$ ./swagger-codegen.sh

The command above will download and run automatic code generation tool against the most recent OpenAPI specification of User API <https://github.com/thoth-station/user-api/>_. Results of the tool are automatically placed into this repository in thamos/swagger_client/ and Documentation/. They consist of automatically generated code as well as documentation on how to use the code <https://github.com/thoth-station/thamos/tree/master/Documentation>_. Thamos itself provides routines built on top of this automated generated code to simplify usage in thamos/lib.