This repository has been archived by the owner on Sep 18, 2024. It is now read-only.
Improve grammar, spelling, and wording within the English documentation. #2223
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
Fix a lot of akward or misleading phrasing. Fix a few spelling errors. Fixed past tence vs presen tense (can vs. could, supports vs supported)
Lots of akward phrasing. Lots of tense issues (could vs can) Lots of spelling errors (especcially "offical") Lots of missing articles Docker is a proper noun and should be capitalized
tab "something" should be the "something" tab. Tense issues (e.g., Modified vs. Modify).
…verview Lots of missing articles. Swapped out "Example usage" for "Example config", because that's what it is. Usage isn't examplified at all. I have no idea what the note at the end of the TPE section is trying to say, so I left it untouched, but it should be changed to something that make sense.
…ners Fixed many incomplete sentences and bad wording. The first sentence in the Parallel TPE optimization section doesn't make sense to me, but I left it in case it's supposed to be that way. That sentence was copied from the blog post.
Also deletes one redundant copy of a note that was stated twice.
|
|
squirrelsc
approved these changes
Mar 23, 2020
|
@AHartNtkn Thanks for the greate job!
I noticed that you change the "Requirement of classArg" into "classArgs requirements:" in the doc of the assessor, but in other docs of tuner, we still used the Requirement of classArg". Thanks for your efforts. |
xuehui1991
reviewed
Mar 23, 2020
docs/en_US/Tuner/HyperoptTuner.md
Outdated
| @@ -23,15 +23,15 @@ tuner: | |||
| ``` | |||
|
|
|||
| **Requirement of classArg** | |||
scarlett2018
approved these changes
Mar 23, 2020
…wo files tuner and builtin assessor.One instance in HyperoptTuner.md and BuiltinAssessor.md.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I found reading through much of the documentation to be pretty frustrating and decided to dedicate some time to fix some of it. This pull request covers the overview, installation, quickstart, most of hyperparameter tuning, and the overview, quickstart, and tutorial for the NAS. Originally, I wanted to cover more, but I lost interest in the face of other, more pressing projects. I figured I'd make a pull request for what's done so that work doesn't go to waste.
I cannot guarantee that every problem is fixed, but the covered docs are far more readable with these changes.