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

Make it a library #183

Open
kenoss opened this issue Mar 31, 2021 · 3 comments
Open

Make it a library #183

kenoss opened this issue Mar 31, 2021 · 3 comments

Comments

@kenoss
Copy link
Contributor

kenoss commented Mar 31, 2021

c.f. #182 (comment)

At a glance, this framework is worth and it is convenient if it is available on PyPI.

Required works are:

  • Make handyrl executable
  • Support user-provided environments and config.yaml.
  • CI (publish to PyPI)
@YuriCat
Copy link
Contributor

YuriCat commented Apr 12, 2021

@kenoss
Thank you for your nice suggestion!
We have been also considering making HandyRL a library, while I'm worried problems about compatibility.

Currently, HandyRL is shared as a tool which is just used for developing strong AIs (and after developing AIs it finishes its role).
If we share HandyRL as a library, however, there will be some users who import HandyRL in a bigger product.
In such a situation, we should take a responsibility to keep compatibility, while this will make code complex...

@kenoss
Copy link
Contributor Author

kenoss commented Apr 13, 2021

I got your point, but I think your anxiety is groundless. Because...

We can use SemVer.
SemVer enables us to express "this update contains breaking change", and also users to notice that change.
Publisher's responsibility is (in this repository's case I think) only to use SemVer correctly.
It is the users' responsibility to write correct requirements and follow updating.

Note that recent build tools like poetry treat SemVer well.
E.g., poetry add command adds caret requirement by default.

Since this tool is small and for training, I guess people accept breaking changes and frequent major updates.
Also, you can declare "this library is under development phase and not stable."

@ikki407
Copy link
Member

ikki407 commented Apr 15, 2021

SemVer is cool! When HandyRL is versioned, sounds good.

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

No branches or pull requests

3 participants