Improve Sophia documentation with Argo/GPT4o #564
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
2. Corrected minor grammatical issues, such as adding commas for clarity. 3. Ensured consistent formatting, such as adding a colon after "To log into Sophia" and ensuring consistent use of periods at the end of sentences.
…pptainer Setup" section for consistency. 2. Fixed grammar: Changed "publish" to "publishing" for parallel structure in the "Building from Docker or Argonne GitHub Container Registry" section. 3. Fixed grammar: Added a comma after "Currently" in the note for clarity. 4. Improved formatting: Removed unnecessary spaces before periods in the links section for consistency.
…graph for clarity. 2. Corrected the total GPU memory from "8320 GB aggregately" to "8,320 GB in total" for consistency and clarity. 3. Improved table header: Changed "COMPONENT" to "COUNT PER NODE" for clarity. 4. Added missing punctuation: Added a period at the end of the first paragraph for proper sentence termination.
…r clarity. 2. Improved formatting: Added bash syntax highlighting for code blocks for better readability. 3. Fixed minor typos: Corrected "BableStream" to "BabelStream" in the example command.
…the binary" for correct preposition usage. 2. Improved formatting: Added bash syntax highlighting to the code block for better readability. 3. Fixed grammar: Added a hyphen in "ALCF-specific" to correctly form a compound adjective.
…zation (e.g., "NVIDIA" instead of "NVidia") and fixing punctuation issues. 2. Improved clarity by rephrasing some sentences for better readability. 3. Fixed broken links by ensuring they are correctly formatted and pointing to the right resources. 4. Enhanced formatting for code snippets by using code blocks with syntax highlighting where applicable. 5. Ensured consistent use of terms and formatting throughout the document, such as using "GPU" instead of "gpu" and "Node" instead of "node" where appropriate.
2. Clarified the extraction step by adding a description. 3. Added bash syntax highlighting for code blocks for better readability. 4. Corrected the dash in the `make -j 16` command to a standard hyphen. 5. Added a description for the interactive job submission step for clarity. 6. Improved the explanation of the benchmark table for better understanding.
…b usage. 2. Improved formatting: Added bash syntax highlighting for code blocks for better readability. 3. Corrected numbering: Adjusted the numbering of steps to be sequential and consistent.
…," and added a comma after "increase" for clarity. 2. Corrected formatting: Changed "40Gb" to "40 GB" for consistency with standard units of measurement. 3. Improved readability: Added bash syntax highlighting to the code blocks for better readability. 4. Capitalization: Corrected "tensorflow" and "pytorch" to "TensorFlow" and "PyTorch" to match their official branding.
2. Fixed grammar: Added "and" between "TensorFlow 2.X" and "PyTorch" for parallel structure. 3. Fixed grammar: Added commas in the list of frameworks and versions for clarity. 4. Improved formatting: Added bash syntax highlighting for the command-line examples for better readability.
… an allocation" for clarity. 2. Added a comma after "new" in the second paragraph for proper punctuation. 3. Corrected the spelling of "NVidia" to "NVIDIA" for consistency with the company's branding. 4. Added a comma after "for instance" in the debug-node queue description for proper punctuation. 5. Added periods at the end of list items under "Queue Restrictions" for consistency in punctuation.
…er" to "Docker" for consistency with proper nouns. 2. Fixed grammar: changed "login to theta" to "log in to Theta" for correct verb usage. 3. Improved formatting: added bash syntax highlighting for code blocks for better readability. 4. Corrected grammar: changed "cdto" to "`cd` to" for clarity. 5. Added hyperlink formatting for the HDF5 source code URL for consistency and clarity. 6. Fixed grammar: changed "pip install you can not" to "pip install you cannot" for correct usage.
…nce structures for clarity. 2. Improved formatting: Ensured consistent use of punctuation and spacing, especially around code blocks and lists. 3. Corrected minor typos: Fixed "bootstap.def" to "bootstrap.def" and ensured consistent capitalization of "NVidia" to "NVIDIA". 4. Enhanced clarity: Rephrased some sentences for better readability and understanding.
…matical correctness. 2. Fixed a missing command in the pip install command for DeepSpeed. 3. Corrected a typo in the footnote: changed "int" to "in" for clarity. 4. Added a missing backslash in the `mpirun` command to ensure proper command continuation. 5. Removed an extra space in the `NGPUS` calculation comment for consistency.
… with," "possesses" instead of "posseses," "increases" to "increased," and "been" to "be." 2. Improved formatting: added syntax highlighting for code blocks for better readability. 3. Completed an unfinished sentence in the data parallelization section. 4. Corrected minor typos and improved sentence structure for clarity.
2. Fixed formatting: Added bash syntax highlighting for code blocks for better readability. 3. Fixed a typo: Removed an extraneous quotation mark in the `export PATH` command. 4. Improved clarity: Added a comma for clarity in the sentence about the `module avail` command.
…r clarity. 2. Fixed grammar: Changed "high level info" to "high-level info" for consistency. 3. Fixed grammar: Changed "setup" to "set up" when used as a verb. 4. Fixed formatting: Removed an unnecessary quotation mark in the `export PATH` command. 5. Fixed grammar: Added a comma after "e.g." for consistency with standard English usage. 6. Improved formatting: Added `bash` and `yaml` syntax highlighting for code blocks for better readability.
…or better readability. 2. Improved formatting: Added bash syntax highlighting to code blocks for readability. 3. Corrected a typo: Changed `PORT3` to `PORT2` in the variable declaration to maintain consistency with the subsequent usage.
…er capitalization. 2. Improved formatting: Added syntax highlighting for bash and cmake code blocks to enhance readability.
…ction for subject-verb agreement. 2. Corrected grammar: Changed "which" to "that" for restrictive clauses. 3. Fixed broken link: Corrected the mailto link for the email address. 4. Improved formatting: Added backticks around the compiler option `-Wno-unknown-cuda-version` for clarity. 5. Improved formatting: Added bash syntax highlighting to code blocks for readability. 6. Clarified instructions: Added "This means" to the warning message explanation for better understanding.
…ble" and removed unnecessary commas. 2. Fixed a typo: Changed "Kokks" to "Kokkos" in the "Building Kokkos on ThetaGPU" section. 3. Improved formatting: Added links to "Kokkos GitHub" and "Kokkos Tutorials" for clarity and consistency. 4. Added bash syntax highlighting for code blocks to improve readability.
…irst sentence for clarity. Removed the caret symbols around "default" as they were unnecessary and not standard markdown syntax. Added a comma after "i.e." for proper punctuation. 2. Fixed formatting issues: Removed extra spaces before punctuation and ensured consistent spacing around parentheses and commas.
…or consistency. 2. Improved formatting: Added bash syntax highlighting for code blocks for better readability. 3. Clarified instructions: Added backticks around command names and paths for consistency and clarity.
…tal rule to improve formatting.
…e structures for clarity. 2. Fixed capitalization: Changed "MacOS" to "macOS" and "i.e" to "e.g." for consistency and correctness. 3. Improved formatting: Added bash syntax highlighting for the command block for better readability. 4. Clarified instructions: Added periods at the end of list items for consistency and clarity.
…tion. 2. Added a period at the end of the first paragraph for consistency. 3. Ensured consistent use of capitalization in section headings. 4. Added a missing closing code block for the Python script at the end.
…kers and ensured consistent use of `-m` with `pip` commands for clarity. 2. Fixed minor formatting issues: Ensured consistent spacing and punctuation, such as removing extra spaces before semicolons and aligning text for readability. 3. Clarified instructions: Improved clarity in the explanation of commands and their purposes.
felker
reviewed
Jan 10, 2025
docs/sophia/compiling-and-linking/compiling-and-linking-overview.md
Outdated
Show resolved
Hide resolved
felker
reviewed
Jan 10, 2025
felker
reviewed
Jan 13, 2025
felker
reviewed
Jan 13, 2025
felker
reviewed
Jan 13, 2025
felker
reviewed
Jan 13, 2025
docs/sophia/not_in_nav/applications-and-libraries/applications/gromacs.md
Show resolved
Hide resolved
felker
reviewed
Jan 13, 2025
docs/sophia/compiling-and-linking/compiling-and-linking-overview.md
Outdated
Show resolved
Hide resolved
felker
reviewed
Jan 13, 2025
felker
approved these changes
Jan 13, 2025
1 task
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.
Similar to #562, I use Argo/GPT4o to improve the documentation. See issue #563.
While this PR is large (27 changed files), 19 of them are not included in the index (in
not_in_navdir). These are mostly from ThetaGPU documentation, should we delete these files?