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

Docs code not working properly #72

Open
DavidSiretMarques opened this issue Oct 19, 2023 · 3 comments
Open

Docs code not working properly #72

DavidSiretMarques opened this issue Oct 19, 2023 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@DavidSiretMarques
Copy link

I just found out about crabnet and I started trying it today with the code provided in the docs This code gives an import problem, as models does not have the function get_data (apparently it seems to have been moved to utils.data, as per this example)

I've also tried the code in the readme and when trying to predict on validation data it gives an error saying that there's no target in the validation data...

Both problems seem to have an easy fix, and maybe it would be a good idea to review the docs and have them up to date with the working code, as to avoid confusion for new users.

@DavidSiretMarques DavidSiretMarques added the bug Something isn't working label Oct 19, 2023
@DavidSiretMarques
Copy link
Author

This is related to this other issue that reports something similar, I think they might be related (if they're not copies of each other)

@sgbaird
Copy link
Member

sgbaird commented Oct 31, 2023

Hi @DavidSiretMarques, I took a look at this. Adding doctests would probably be for the best. If you make a PR, happy to look over it, otherwise I'll try to make some time to fix the docs. Maybe https://colab.research.google.com/github/sparks-baird/CrabNet/blob/main/examples/crabnet_basic_colab.ipynb can be of help, too.

@DavidSiretMarques
Copy link
Author

I've never done doctests, but If I have some time I'd love to try, I'll keep you posted if I plan on doing a PR, thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants