fix: readme #196
Merged
fix: readme #196
Conversation
This file contains 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
bilalaws
reviewed
Feb 21, 2024
README.md
Outdated
| ### Setup | ||
| Once a virtual environment is set up with python3.10, run the following command to install all dependencies: | ||
| ### Setup and the use of `devtool` | ||
| Once you have set up virtual environment with python3.10, run the following command to install `devtool`: |
There was a problem hiding this comment.
Suggestion: For the sake of clarity: change this to "... run the following command to setup the development environment ..." and remove the sentence "Then you can install the library with all dependencies ...". We anyways mention ./devtool all one sentence later (the sentence starting with "Before submitting a PR ...")
bilalaws
approved these changes
Feb 26, 2024
xiaoyi-cheng
approved these changes
Feb 26, 2024
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.
Updates to
README.mdto address some points in our internal pain points doc.get_eval_algorithmfrom example usage as it's no longer recommended.devtool.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.