Skip to content

FAIR fields and Hypha Upload #710

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

FAIR fields and Hypha Upload #710

wants to merge 8 commits into from

Conversation

FynnBe
Copy link
Member

@FynnBe FynnBe commented Jul 29, 2025

No description provided.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 29, 2025
@oeway
Copy link
Contributor

oeway commented Jul 29, 2025

What is FAIR Field? e.g. FAIR[int]?

@FynnBe
Copy link
Member Author

FynnBe commented Jul 29, 2025

A field that not needed for executing/using a model/dataset/notebook, but that is part of the metadata making the resource FAIR.
(Just because that's probably where you have your example from; the FAIR[int] annotation in the test is pretty meaningless).
my_field: FAIR[Optional[int]] = None would make my_field optional, but if set to None (or an empty sequence, e.g. FAIR[str] = "") an alert (warning with slightly higher warning level than a regular warning) is raised that this field is needed to make the description FAIR.

This will make it easier to tinker with models etc. and allow core to work with models that do not fully comply with the FAIR part of the metadata, e.g. not failing prediction because authors are incorrectly specified.

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