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

[feature] : Document where to obtain lab U-Nets #1103

Open
SylviaWhittle opened this issue Mar 10, 2025 · 1 comment
Open

[feature] : Document where to obtain lab U-Nets #1103

SylviaWhittle opened this issue Mar 10, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@SylviaWhittle
Copy link
Collaborator

Is your feature request related to a problem?

In grain_finding.md we mention that one can optionally use U-Nets with TopoStats however we do not yet provide any U-Nets.

We should list the U-Nets that we make available through our publications. How we should do that can be discussed and implemented.

Describe the solution you would like.

Write up documentation on where to obtain our publicly available U-Nets that the lab has trained in the grain_finding.md documentation.

Describe the alternatives you have considered.

N/A

Additional context

N/A

@SylviaWhittle SylviaWhittle added the enhancement New feature or request label Mar 10, 2025
@ns-rse
Copy link
Collaborator

ns-rse commented Mar 10, 2025

Some options...

  • Make them part of the website and available to download (would sit in docs/assets and we should include SHA256 checksums for the files so people can check the veracity of what they download).
  • Bundle them into TopoStats itself is also an option but this may bloat the package size and impact on its hosting on PyPI.
  • Deposit models in Zenodo or ORDA and link to them (makes the "dataset"/model citeable with a unique DOI).

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

No branches or pull requests

2 participants