Skip to content

Comments on README #2

@landerlini

Description

@landerlini

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!

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions