leap.yaml

Descirbes the leap.yaml configuration - it's fields and usage

The leap.yaml is placed at the project root. It is a mendatory configuration file holds several pieces of informaton required by the Tensorleap server:

• codeIntegrationID: an ID that represents a dataset in the Tensorleap platform.

• projectID: (optional) an ID that represents a project in the Tensorleap platform.

• secretID: (optional) an ID that represents a secret in the Tensorlep platform.

• An indicator of which files should be sent to the server relative to the current path.

  • include: a list of relative file path to upload to the setver

  • exclude: a list of relative file path to ignore from server upload.

Both the include and exclude syntax support a * selection (i.e. *.py)

• pythonVersion: The expected python version to build your dependencies file with when supplying a requirements.txt file.

This stateful configuration allows the CLI to know which object should it upload the assets to when communicating with the server.

leap.yaml Example

codeIntegrationId: 6854749d0d49a6e4c09ec11b
projectId: 685474990d49a6e4c09ec115
secretId: ""
entryFile: leap_binder.py
include:
    - leap_binder.py
    - leap_mapping.yaml
    - mnist/config.py
    - mnist/project_config.yaml
    - mnist/utils.py
    - mnist/data/preprocess.py
    - requirements.txt
pythonVersion: py310

In the case of initial integration, or if the code-base & model should be uploaded to a different place it is expected to have the leap.yaml without the rows of the codeIntegrationId, projectId, secretId and pythonVersion. Going through the CLI upload process would then interactively allow a selection of these objects, which would then be automatically filled to the leap.yaml