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

Make some fields optional in the general RDF #375

Merged
merged 6 commits into from
Jan 19, 2022
Merged

Conversation

oeway
Copy link
Contributor

@oeway oeway commented Jan 15, 2022

For general RDF and collection, forcing authors, cite, documentation, and tags does not make sense all the time. It's much better to make these non-critical fields optional.

For example, when the RDF item is not published anywhere, there won't be much to fill for the authors and cite fields. tags is helpful for searching but it's not critical, similar case for documentation (note we have description already).

Another use case is to generate and use RDFs offline, e.g. with the bioimageio.core package if we generate a model RDF for offline use, we will have to generate empty fields for authors, cite, tags and documentation which seems unnecessary. They only make sense if we want to upload the model to the model zoo, but we can always enforce them when uploading to the website or as part of our approval criterion.

The fields change is non-breaking and it means a minimal RDF file should have the following fields:

  • format_version
  • name
  • type
  • description

This PR also includes moving the general RDF examples to a separate file to make it easier to find the link for model/collection spec.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 15, 2022
Copy link
Collaborator

@constantinpape constantinpape left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good to me. Do you need to have this immediately or can we wait with merging until @FynnBe had a chance to look at this, who is more familiar with this part of the code?

@oeway
Copy link
Contributor Author

oeway commented Jan 19, 2022

All the tests passes now, I will merge this now to get all the collections working on the website. If @FynnBe spotted anything later we can patch it with another PR.

@oeway oeway merged commit 5d13c39 into main Jan 19, 2022
@oeway oeway deleted the make-optional-fields branch January 19, 2022 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants