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

[Suggestion] Add type hints #293

Open
riiswa opened this issue Mar 10, 2023 · 2 comments
Open

[Suggestion] Add type hints #293

riiswa opened this issue Mar 10, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers Marathon To do during Marathon style This is a code style issue

Comments

@riiswa
Copy link
Collaborator

riiswa commented Mar 10, 2023

I think adding type hinting can improve the overall quality of rlberry, but it will be a huge work. What do you think ?

@TimotheeMathieu
Copy link
Collaborator

TimotheeMathieu commented Mar 10, 2023

I think this is a good idea and we don't have to do everything at once, we could do something gradual

  • Do a PR that add type hint to the principal algorithms of rlberry (AgentManager, plot and eval functions, Base classes like Model and AgentWithSimplePolicy...).
  • Use typing in the new PR
  • Do other PR to step by step have it in all rlberry

On the other hand, I think for now improving the documentation should come first (in particular issue #188 and add some tutorials to populate the user guide), but this is just my opinion. We can keep this issue for later maybe.

@riiswa
Copy link
Collaborator Author

riiswa commented Mar 14, 2023

Duplicated from #15

@KohlerHECTOR KohlerHECTOR added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers style This is a code style issue Marathon To do during Marathon labels Jul 13, 2023
@YannBerthelot YannBerthelot self-assigned this Jul 24, 2023
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 enhancement New feature or request good first issue Good for newcomers Marathon To do during Marathon style This is a code style issue
Projects
None yet
Development

No branches or pull requests

4 participants