Any pypi package?

[zhimin-z]

Describe the feature

see the title

Potential Solutions

see the title

[deepakn97]

Hi @zhimin-z

Currently, we don't plan to release a pypi package for MLGym.
However, we would appreciate it if you want to make a Python package for this repo.
I will keep this issue open so that we can revisit this request in the future.

[PriyaDCosta]

Hi, I would love to be involved in making this a PyPi package. However, since this project is under heavy development, do you think this should wait?

[deepakn97]

Thank you, @PriyaDCosta, for expressing interest. You are right; we should wait until the functionality is stable.

Ideally, we want to separate the task files and data so that the MLGym PyPI package only includes the core functionality for agents, environments, and task handling. Since users can add their task config files, the PyPI package should not include those config files and task data.

[PriyaDCosta]

Sounds good! I will prepare a design doc that incorporates the core functionality into the PyPi format, so we can pick off from there once the core functionality is relatively stable.

[PriyaDCosta]

I was able to separate the configs from the functionality and convert run.py into an object to which we can pass in configs as parameters over here - https://github.com/PriyaDCosta/MLGym.git . Just wanted to know whether there any updates on - (1) when the design will be relatively stable and (2) when more documentation will be released?, so that we can work towards a more stable and functional python package.

Planning to work on incorporating visualizations next

[deepakn97]

Hi @PriyaDCosta
Thank you for the changes. I will look through them.
We have been working on stabilizing the design and pushing more things into the MLGym package. Please look at pr #16 and #17 in the repo.
Tagging @ken-tummada here who is working on stabilizing the repo and design.

[PriyaDCosta]

Thanks! I will take a look at the PRs. Are there any plans in place for developing any documentation, I am happy to support there!

[deepakn97]

Hey @PriyaDCosta

Yes, we are currently making extensive changes to simplify the API. The estimated timeline for integrating these changes is around July 10th. Once we have integrated these changes, it will enable us to organize the documentation and convert it into a PyPI package.
I apologize for the regular delays in responding to the issues. We will let you know once we are done with the integration and we would be happy to work together for both documentation and creating the PyPI package. Appreciate the patience from your side!

[PriyaDCosta]

No worries and thank you! I am looking forward to collaborating on the package and the documentation!