Skip to content

Commit eff451e

Browse files
authored
Merge branch 'main' into add-notices
2 parents 7908e96 + d0c52c8 commit eff451e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,15 @@ TorchJD provides many existing aggregators from the literature, listed in the fo
292292
| [Sum](https://torchjd.org/stable/docs/aggregation/sum#torchjd.aggregation.Sum) | [SumWeighting](https://torchjd.org/stable/docs/aggregation/sum#torchjd.aggregation.SumWeighting) | - |
293293
| [Trimmed Mean](https://torchjd.org/stable/docs/aggregation/trimmed_mean#torchjd.aggregation.TrimmedMean) | - | [Byzantine-Robust Distributed Learning: Towards Optimal Statistical Rates](https://proceedings.mlr.press/v80/yin18a/yin18a.pdf) |
294294

295+
## Release Methodology
296+
297+
We try to make a release whenever have something worth sharing to users (bug fix, minor or large
298+
feature, etc.). TorchJD follows [semantic versioning](https://semver.org/). Since the library is
299+
still in beta (`0.x.y`), we sometimes make interface changes in minor versions. We prioritize the
300+
long-term quality of the library, which occasionally means introducing breaking changes. Whenever a
301+
release contains breaking changes, the [changelog](CHANGELOG.md) and the GitHub release notes always
302+
include clear instructions on how to migrate.
303+
295304
## Contribution
296305
Please read the [Contribution page](CONTRIBUTING.md).
297306

0 commit comments

Comments
 (0)