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

Misc comments #4

Closed
wants to merge 1 commit into from
Closed

Misc comments #4

wants to merge 1 commit into from

Conversation

LysandreJik
Copy link
Member

@LysandreJik LysandreJik commented Jan 30, 2024

Only gave a quick look for now, but it's an impressive codebase! It's already very clean, I didn't see anything that jumped to me as being out of the ordinary.

In no specific order, comments about the codebase:

  • I would add a stronger message that it originated from the EAIH
  • Cool to see initial brrr support!
  • Overall well documented and navigation is easy
  • Are you expecting to see it be used in conjunction with the doc-builder? It definitely seems like it could be supported
  • Very object-oriented/class based which is great.
  • You have some env var management in the middle of class definitions (namely os.environ["TOKENIZERS_PARALLELISM"] = "false"). I would either move this in one of the higher-level modules or just put it in the main script
  • Some docstrings are yet to be filled out (like the loglikelihood)

@NathanHB
Copy link
Member

Thanks Lysandre !

I would add a stronger message that it originated from the EAIH

Do you mean in the README or the code (when using a function that comes from there for example) ?

Are you expecting to see it be used in conjunction with the doc-builder? It definitely seems like it could be supported

Yes, I'm adding some more docstring in another PR then we will use a doc builder.

Thanks for the input on all of these, we will take them into account and try to have fixes this week :)

@clefourrier
Copy link
Member

We need to do both, but especially be super strict on code attribution imo - it was a super cool inspiration on a number of classes.

@clefourrier
Copy link
Member

clefourrier commented Feb 20, 2024

Going to close this PR, thanks again a lot @LysandreJik for your feedback!
The 2 last things remaining are the env var and doc, I've created issues so we don't lose track of them.

@clefourrier clefourrier mentioned this pull request Feb 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants