Add documentation about poetry environment and installation #561
Conversation
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
| @@ -43,13 +43,14 @@ install ModelBench as a CLI tool or library to use in your own projects. | |||
| ```shell | |||
| pipx install poetry | |||
| ``` | |||
| Please be sure to install Poetry in a dedicated python virtual environment separate from the environment used for this project. | |||
There was a problem hiding this comment.
This is a surprise to me. Doesn't pipx create its own environment?
If it is something you want people to do, you'll have to give more detail.
There was a problem hiding this comment.
Pipx does create its own virtual environment(s) for everything you install in it.
|
|
||
| 2. Clone this repository. | ||
| ```shell | ||
| git clone https://github.com/mlcommons/modelbench.git | ||
| ``` | ||
|
|
||
| 3. Install ModelBench and dependencies. | ||
| 3. Install ModelBench and dependencies. Make sure the dedicated python environment you used to install Poetry is not activated when running poetry commands. |
There was a problem hiding this comment.
What's written here seems to me not to be the case. I haven't had problems running poetry from the project's environment, or from the default one. If there is something you want people to do, you'll at least have to be more explicit about it, and possibly mention the error message they'd be seeing if they don't do what you want.
There was a problem hiding this comment.
It's not the project's environment that's the problem, it's the environment that was created to install poetry. This is based on the installation section of the poetry docs https://python-poetry.org/docs/
No description provided.