Metadata-Version: 2.4
Name: miroir
Version: 0.0.1
Summary: Client, host CLI, and TRL and verifiers adapters for Miroir RL environments
License-Expression: Apache-2.0
License-File: LICENSE
Requires-Dist: websockets>=15
Requires-Dist: trl>=1.17 ; extra == 'trl'
Requires-Dist: datasets>=4.7 ; extra == 'trl'
Requires-Dist: verifiers>=0.4.1,<0.5 ; extra == 'verifiers'
Requires-Python: >=3.11
Project-URL: Repository, https://github.com/raphaelDkhn/miroir
Project-URL: Documentation, https://github.com/raphaelDkhn/miroir/tree/master/docs/src
Provides-Extra: trl
Provides-Extra: verifiers
Description-Content-Type: text/markdown

# miroir

The Python package of [Miroir](https://github.com/raphaelDkhn/miroir), which turns a product's
Docker image into a reinforcement-learning environment. It holds the client that leases
containers and runs episodes, the host CLI, and the TRL and verifiers adapters.

```sh
uv pip install miroir               # the client and the host CLI
uv pip install 'miroir[trl]'        # with the TRL adapter
uv pip install 'miroir[verifiers]'  # with the verifiers adapter
```

Start with the [quick start](https://github.com/raphaelDkhn/miroir#quick-start), then the
[client guide](https://github.com/raphaelDkhn/miroir/blob/master/docs/src/train/client.md).
