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

[Feature Request] Publish a class interface - AbstractVecEnv #244

Open
1 task done
ikamensh opened this issue Feb 15, 2023 · 0 comments
Open
1 task done

[Feature Request] Publish a class interface - AbstractVecEnv #244

ikamensh opened this issue Feb 15, 2023 · 0 comments
Assignees

Comments

@ikamensh
Copy link

Motivation

I'm developing with envpool dependency from macos, and I can't install it. As a result I can't see what methods are available on envpool.env object; I also can't use type checking to verify my code has no obvious bugs. This probably would still be the case on Linux, but I'm not as sure.

Solution

An interface that describes public methods and fields of vecenv, which is ideally installable as pip install envpool[interface], would allow me to have all type checks / hints from IDE. It would also define clearly on what functionality dependencies can depend on, and what are private implementation details.

Alternatives

  • do nothing - developers can just read docs / run code to see if they use correct fields / methods

Checklist

  • I have checked that there is no similar issue in the repo (required)
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

2 participants