search

machine-learning-exchange / katalog

MLX Katalog is a project to hold the default content samples to bootstrap Machine Learning eXchange.
Apache License 2.0
11 stars 13 forks source link

Add `id` field to notebook YAML #35

Closed ckadner closed 3 years ago

ckadner commented 3 years ago

Currently the notebook YAMLs do not have an id or notebook_identifier field. This makes it hard to reference a notebook as a related_asset from other assets, like datasets.

Note: Make sure the value of the ids added to the YAML files match the existing ones:

curl -X GET --header 'Accept: application/json' 'http://ml-exchange.org/apis/v1alpha1/notebooks' -s | grep '"id":'
      "id": "aif360-bias-detection-example",
      "id": "art-detector-model",
      "id": "art-poisoning-attack",
      "id": "jfk-airport-analysis",
      "id": "project-codenet-language-classification",
      "id": "project-codenet-mlm",
      "id": "qiskit-neural-network-classifier-and-regressor",
      "id": "qiskit-quantum-kernel-machine-learning",

These got generated from the name of the notebook, by lower-casing and replacing the spaces with dashes -

Related issues:

ckadner commented 3 years ago

@JAulet

JAulet commented 3 years ago

So for this issue I should go through the notebook YAMLs in this repository and add the id? @ckadner

ckadner commented 3 years ago

Yes. For example, the CodeNet Language Classification notebook would get this id:

id: codenet-lang