Make some fields optional in the general RDF #375
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
andcite
fields.tags
is helpful for searching but it's not critical, similar case fordocumentation
(note we havedescription
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
anddocumentation
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:
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.