Skip to content

Maintain usage examples and their tests#215

Merged
ValerianRey merged 5 commits intomainfrom
maintain-doc-tests
Dec 14, 2024
Merged

Maintain usage examples and their tests#215
ValerianRey merged 5 commits intomainfrom
maintain-doc-tests

Conversation

@ValerianRey
Copy link
Copy Markdown
Contributor

  • Use only floating point values in the definition of J in TrimmedMean's usage example
  • Reorder imports in rst examples
  • Add module docstrings for tests/doc modules
  • Remove filterwarnings in cagrad and nash_mtl usage examples
  • Wrap extra code of doc tests into Extra blocks

@ValerianRey ValerianRey added cc: docs Conventional commit type for changes to the documentation. cc: test Conventional commit type for changes to tests. labels Dec 14, 2024
@ValerianRey ValerianRey self-assigned this Dec 14, 2024
@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
src/torchjd/aggregation/cagrad.py 97.56% <ø> (ø)
src/torchjd/aggregation/nash_mtl.py 88.23% <ø> (ø)
src/torchjd/aggregation/trimmed_mean.py 92.85% <ø> (ø)

@ValerianRey ValerianRey changed the title Maintain doc tests Maintain usage examples and their tests Dec 14, 2024
@ValerianRey ValerianRey merged commit a81e64d into main Dec 14, 2024
@ValerianRey ValerianRey deleted the maintain-doc-tests branch December 14, 2024 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cc: docs Conventional commit type for changes to the documentation. cc: test Conventional commit type for changes to tests.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant