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

Add clear documentation to avoid using this repo for predictions #82

Open
ngreenwald opened this issue Jun 14, 2024 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@ngreenwald
Copy link
Member

Is your feature request related to a problem? Please describe.
It seems that because this repo has the name Nimbus, if people just search for the github rather than following the link from the paper, they may think this is the one they're supposed to be using.

Describe the solution you'd like
Update the readme to clearly indicate that if all people want to do is run the trained model, they should instead use the inference repo. We should probably add the same thing to the nimbus prediction notebook in this repo, or maybe remove it.

@ngreenwald ngreenwald added the enhancement New feature or request label Jun 14, 2024
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

1 participant