Ingest models

You can ingest your models in the same way that you ingest datasets.

CLI

The CLI is the most convenient way to ingest models. You can ingest a model using the following CLI command:

eotdl models ingest -p "model-path"

Where model-path is the path to a folder containing your model and any other relevant files.

For Q0 models, a file named README.md is expected in the root of the folder. This file should contain the following information:

---
name: model-name
authors: 
  - author 1 name
  - author 2 name
  - ...
license: model license
source: link to source
thumbnail: link to thumbnail (optional)
---

some markdown content (titles, text, links, code, images, ...)

If this file is not present, the ingestion process will fail.

After uploading a model with the CLI you can visiting the model page to edit this information.

You can update your model in multiple ways. If you modify your local folder and run the ingest command again, a new version will be created reflecting the new data structure and files.

If the metadata in the README.md file is not consistent with the one in the platform (either because you edited the file or because you edited the model in the platform), you should use:

• the --force flag to overwrite the metadata in the platform with the one in the README.md file.
• the --sync flag to update your file with the metadata in the platform.

Q1+ models are not supported yet

Library

You can ingest models using the following Python code:

from eotdl.models import ingest_model

ingest_model("model-path")