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

Comments on README #2

Open
landerlini opened this issue May 25, 2021 · 0 comments · May be fixed by #3
Open

Comments on README #2

landerlini opened this issue May 25, 2021 · 0 comments · May be fixed by #3
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@landerlini
Copy link
Collaborator

Hi @mbarbetti,
great job! Here some comments in sparse order.

General comments on the package development

  1. Please include uvicorn and requests in the dependencies listed in setup.py
  2. Release the package on PyPI in order to allow people to install it simply with pip install optunapi
  3. Add a client class that allows to hide the complexity of the parsing of the HTTP response to the user. This might seem an overkill, but it respond to the need for encapsulation making the package more maintainable in the future. Keep (and expand in the future) the documentation on how to interact without that additional layer for "power users". The new class may mimic trial class in optuna in the interface. This would make easier to the user to start the development using optuna and then switching to optunapi at a further stage of the development without modifying too much of his code except for the "trial" provider.
  4. Add an API to add a hyper parameter or to upload the configuration to the server. This is a step towards making this package a service (the user does not have control on the filesystem of the server).

Editorial comments
Be careful with the "s". Read again the whole README and make sure you have the right "s" at the end of the right "words".

Well done!

@mbarbetti mbarbetti self-assigned this Jul 15, 2021
@mbarbetti mbarbetti added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed and removed help wanted Extra attention is needed labels Jul 15, 2021
@mbarbetti mbarbetti linked a pull request Jul 26, 2021 that will close this issue
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants