Skip to main content

TANGO Model Template

This template is useful to initialize a new TANGOModel (with MLFlow as MLOps framewor) project using cookiecutter.

What is available​

A skeleton of a TANGO Model project with the main components already implemented:

  • Model definition and mapper classes
  • Training script
  • MLFlow project file

How to launch​

First, install Cookiecutter

Then the template can be launched using the latest stable version with the command:

cookiecutter https://gitlab.com/tango-ecosystem/templates/tango-model-template.git

It is also possible to switch to another branch or tag by adding the --checkout argument followed by the branch or tag in which you want to check out.

What are the options for configuring it​

After the launch of the command the following configuration options should be configured:

  • project_name: The name of the project.
  • project_slug: The slug of the project that is used as folder name of the project.

What to do after the initial creation on the new project​

After the initial creation of the new project, the following steps should be performed:

  1. Looks for TODO comment in the code, some parts of the repository should be personalized. The project is meant to be used as a template, so the code should be personalized to fit the needs of the project.
  2. Follow the insrction in the generated README.md file to install the dependencies and run the project.