docs: fix typos in docstrings, comments, and user docs#4040
Open
mokashang wants to merge 1 commit into
Open
Conversation
Corrects spelling mistakes flagged by codespell across user-facing help strings, docstrings, comments, and concept guides: - "checkoint" -> "checkpoint" (FSDP help in CLI + docs + docstring + dataclass help) - "Parallellism" -> "Parallelism" (links in context/sequence parallelism guides) - "destoying" -> "destroying" (Accelerator.end_training docstring) - "especiall" -> "especially", "wil" -> "will" (accelerator.py comments/docstrings) - "unexepected" -> "unexpected", "seemless" -> "seamless" - "relevent" -> "relevant" (two occurrences), "examle" -> "example" - "pleae" -> "please", "overlayed" -> "overlaid" - "additionaly" -> "additionally", "reguire" -> "require", "roughtly" -> "roughly"
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
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.
What does this PR do?
Fixes a batch of spelling mistakes flagged by
codespellacross user-facing help text, public docstrings, internal comments, and concept guides. All changes are confined to comments, docstrings, markdown, and--helpstrings; no behavior or public API changes.Source code
src/accelerate/accelerator.py:even_batchesarg ofjoin_uneven_inputs)Accelerator.end_trainingdocstring)src/accelerate/commands/launch.py: "checkoint" → "checkpoint" (--fsdp_cpu_ram_efficient_loadinghelp)src/accelerate/utils/dataclasses.py: "checkoint" → "checkpoint" (×2 inFullyShardedDataParallelPlugindocstring + field metadata help)src/accelerate/utils/modeling.py: "unexepected" → "unexpected" (load_checkpoint_in_modelcomment)Documentation
docs/source/package_reference/cli.md: "checkoint" → "checkpoint"docs/source/usage_guides/compilation.md: "seemless" → "seamless"docs/source/usage_guides/low_precision_training.md: "relevent" → "relevant" (×2)docs/source/usage_guides/megatron_lm.md: "examle" → "example"docs/source/concept_guides/context_parallelism.md: "Parallellism" → "Parallelism" (link text)docs/source/concept_guides/sequence_parallelism.md: "Parallellism" → "Parallelism" (×2 link text), "pleae" → "please", "overlayed" → "overlaid"Benchmarks
benchmarks/fsdp2/utils.py: "additionaly" → "additionally", "reguire" → "require"benchmarks/fsdp2/visualize.py: "roughtly" → "roughly"Testing
codespellon all changed paths; clean.ruff format --checkpasses on the modified files.pytest tests/test_utils.pyandpytest tests/test_cli.py(minus the gated transformers-only test) all pass.argparsehelp strings reflect the corrections.Before submitting