Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Extend the example JSON definition to Assets #4

Open
Tracked by #7 ...
fmigneault opened this issue Mar 29, 2024 · 0 comments
Open
Tracked by #7 ...

Proposal: Extend the example JSON definition to Assets #4

fmigneault opened this issue Mar 29, 2024 · 0 comments

Comments

@fmigneault
Copy link

For the Machine Learning Model (MLM) extension, one of the Assets consist of the "source code" required to run the model training or inference pipeline. Provided that this definition is in itself a great example on how to run the model, it would make sense to mark it as such.

The current definition of the "source code" is as follows:

{
  "assets": {
    "source-training": {
      "href": "https:/github.com/org/repo/app.py",
      "type": "text/x-python",
      "title": "Source code to train the ML model.",
      "roles": [
        "ml-model:training-runtime",
        "mlm:model",
        "code",
        "metadata"
      ],
      "mlm:entrypoint": "app:train"
    }
  }
}

As we can see, there are strong resemblances to the example links, since details such as example:container and example:language would be relevant here as well. However, in the context of MLM, this script cannot be "only" considered an rel: example, since it is the definition that really tells us how to run it. An Asset seems more appropriate, since it is core to using the model itself.

While defining this "source code asset", similar consideration to the example:container field were also brought up (see https://github.com/crim-ca/dlm-extension/blob/validate/README.md#source-code-asset). If possible, I would like to leverage the example fields directly under the asset, instead of reinventing them with mlm: prefix. Another field that was relevant in our opinion is mlm:entrypoint, in case the referenced code has more than one function. This could be added to the exemple extension as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant