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

extend metadata schema to provide a field for custom entries #2312

Closed
RafalSkolasinski opened this issue Aug 21, 2020 · 1 comment · Fixed by #2376
Closed

extend metadata schema to provide a field for custom entries #2312

RafalSkolasinski opened this issue Aug 21, 2020 · 1 comment · Fixed by #2376
Assignees
Labels
Milestone

Comments

@RafalSkolasinski
Copy link
Contributor

RafalSkolasinski commented Aug 21, 2020

It seems that our metadata schema is over restrictive and we should explore extending it to allow users providing a custom set of parameters they would like to store as metadata.

Current suggestion is to allow one more top-level key, tags, that will store key-value pairs.
This would allow for storing arbitrary information like build number, training data identifier or training parameters.

$metadata_model_response =
{
  "name" : $string,
  "versions" : [ $string, ... ] #optional,
  "platform" : $string,
  "inputs" : [ $metadata_tensor, ... ],
  "outputs" : [ $metadata_tensor, ... ],
  "tags": { $string: $string, ....}
}

Example:

{
   ...
   "tags": {
      "build": 101,
      "training-data": "my-set-01",
   },
   ...
}

Note: this is about static /metadata endpoint and NOT the request tags

@RafalSkolasinski RafalSkolasinski added triage Needs to be triaged and prioritised accordingly metadata labels Aug 21, 2020
@ukclivecox ukclivecox removed the triage Needs to be triaged and prioritised accordingly label Aug 27, 2020
@ukclivecox ukclivecox added this to the 1.3 milestone Aug 27, 2020
@RafalSkolasinski RafalSkolasinski changed the title extend metadata schema to provide custom "tags" extend metadata schema to provide a field for custom entries Aug 27, 2020
@RafalSkolasinski
Copy link
Contributor Author

New new field will be called custom.

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

Successfully merging a pull request may close this issue.

2 participants