Readme update #8
Merged
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
palmskog
reviewed
Nov 21, 2020
README.md
Outdated
| @@ -8,6 +8,7 @@ section below. | |||
|
|
|||
| ## Requirements | |||
|
|
|||
| - Supported operating systems: Linux, Mac | |||
There was a problem hiding this comment.
Suggested change
| - Supported operating systems: Linux, Mac | |
| - Linux or macOS |
README.md
Outdated
Comment on lines
105
to
117
| You need to obtain a pre-trained model that capture naming | ||
| conventions. The default pre-trained model, which was trained using | ||
| our [corpus][math-comp-corpus] and follows the conventions used in the | ||
| [Mathematical Components][math-comp-website] family of projects, can | ||
| be obtained by running the command: | ||
|
|
||
| ``` | ||
| ./bin/roosterize download_global_model | ||
| ``` | ||
|
|
||
| The model will be downloaded to `$HOME/.roosterize/`. To use a | ||
| different model (that we [released][latest-release] or you trained), | ||
| simply put it in `$HOME/.roosterize/`. |
There was a problem hiding this comment.
This part should go before the "Usage" subsection, under "Installation of Roosterize and trained models" just above, replacing the current content there.
|
Thanks Karl! Addressed your comments, and I'll go ahead and merge this. |
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.
Updating README.md to conform to the latest changes - the conda env files, new download_global_model and suggest_naming commands. Extracted the example suggestion output to a separate file.
@palmskog please take a look when you get a chance. Thanks!