leap.yaml

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

The leap.yaml configuration file is located at the project root. It is a mandatory configuration file that contains several pieces of information 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 Tensorleap platform.

• entryFile: The path to a python file that includes the tensorleap integration test

• 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 server.

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

Both the include and exclude fields support wildcards (e.g. *.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 it should upload the assets to when communicating with the server.

leap.yaml Example

Include Example

The leap.yaml can use the include syntax to state which files should be uploaded to the platform

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

Exclude Example:

The leap.yaml can use the exclude syntax to state which files should be uploaded to the platform

codeIntegrationId: 6854749d0d49a6e4c09ec11b
projectId: 685474990d49a6e4c09ec115
secretId: ""
entryFile: leap_binder.py
exclude:
  - "**/*.h5"
  - "**/*.onnx"
  - "**/*.jpg"
  - "**/*.png"
pythonVersion: py310

For initial integration or when uploading the code-base and model to a new location, the leap.yaml should not include codeIntegrationId, projectId, secretId, and pythonVersion rows. During the CLI upload process, you can select these objects interactively, and they will be automatically added to leap.yaml.