Revise README with installation and usage details #34
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Alternative version of the README. This is not at all meant to be a drop-in replacement for the current readme, but rather a starting point for discussion and a push for better documentation. Let's discuss what to carry over to the README.
Comment on lines
+10
to
+15
| ``` | ||
| docker build -t project-name -f docker/Dockerfile . | ||
| docker run --gpus all -it \ | ||
| -v $(pwd):/workspace \ | ||
| project-name | ||
| ``` |
Contributor
There was a problem hiding this comment.
Do we want the user to build their own Docker image? We have a CI that builds a new one on every push on the master (for both ARM64 and AMD64 architecture), if a user wants to revert back to an old version of the master, they can do so by updating the tag. It would be better for them to just:
Suggested change
| ``` | |
| docker build -t project-name -f docker/Dockerfile . | |
| docker run --gpus all -it \ | |
| -v $(pwd):/workspace \ | |
| project-name | |
| ``` | |
| # Uncomment for ARM64 architecture | |
| # docker pull michelducartier24/multimeditron-git:latest-arm64 | |
| docker pull michelducartier24/multimeditron-git:latest-amd64 |
|
|
||
| If Docker is not used, install dependencies manually: | ||
| ``` | ||
| pip install -r requirements.txt |
Contributor
There was a problem hiding this comment.
Suggested change
| pip install -r requirements.txt | |
| pip install ".[flash-attn]" |
Comment on lines
+68
to
+76
| Aggregate and post-process results: | ||
| ```bash | ||
| python scripts/analyze.py | ||
| ``` | ||
|
|
||
| Generate plots and figures: | ||
| ```bash | ||
| python scripts/plot.py | ||
| ``` |
Contributor
There was a problem hiding this comment.
We don't really have a lot of plots and figures at the moment (just tables), but maybe for the future, it would be great
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Alternative version of the README.
This is not at all meant to be a drop-in replacement for the current readme, but rather a starting point for discussion and a push for better documentation.
Let's discuss what to carry over to the README.