Skip to content

Commit

Permalink
Update major version and fix links
Browse files Browse the repository at this point in the history
Signed-off-by: Vivek Joshy <[email protected]>
  • Loading branch information
vivekjoshy committed Jul 15, 2024
1 parent 9d49c29 commit ca3be34
Show file tree
Hide file tree
Showing 12 changed files with 76 additions and 58 deletions.
2 changes: 1 addition & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"projectName": "openskill.py",
"projectOwner": "OpenDebates",
"projectOwner": "vivekjoshy",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
Expand Down
2 changes: 1 addition & 1 deletion .bumpversion.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tag = false
sign_tags = false
tag_name = "v{new_version}"
tag_message = "Bump version: {current_version} → {new_version}"
current_version = "5.1.1"
current_version = "6.0.0"
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+)\\.(?P<build>\\d+))?"
serialize = [
"{major}.{minor}.{patch}-{release}.{build}",
Expand Down
84 changes: 53 additions & 31 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,35 @@ This file is updated every release since v1.0.0 with the use of towncrier from t

.. towncrier release notes start
Openskill 6.0.0 (2024-07-15)
============================

Breaking Changes
----------------

- Prediction methods better account for uncertainty. (`#138 <https://github.com/vivekjoshy/openskill.py/issues/138>`_)


Features
--------

- Support Per Player Weights and Balance Flag. (`#138 <https://github.com/vivekjoshy/openskill.py/issues/138>`_)
- Prediction methods have faster runtime. (`#138 <https://github.com/vivekjoshy/openskill.py/issues/138>`_)


Bugfixes
--------

- Fix issue causing limit_sigma not being set implicitly. (`#132 <https://github.com/vivekjoshy/openskill.py/issues/132>`_)


Openskill 5.1.1 (2024-02-03)
============================

Bugfixes
--------

- Resolves incorrect predictions for matches of size greater than 2. (`#124 <https://github.com/OpenDebates/openskill.py/issues/124>`_)
- Resolves incorrect predictions for matches of size greater than 2. (`#124 <https://github.com/vivekjoshy/openskill.py/issues/124>`_)


Openskill 5.1.0 (2023-08-24)
Expand All @@ -19,13 +41,13 @@ Openskill 5.1.0 (2023-08-24)
Features
--------

- Optimize rating objects for deepcopy (`#108 <https://github.com/OpenDebates/openskill.py/issues/108>`_)
- Optimize rating objects for deepcopy (`#108 <https://github.com/vivekjoshy/openskill.py/issues/108>`_)


Bugfixes
--------

- model.rating() methods no longer revert to default model parameters when arguments are 0 (`#109 <https://github.com/OpenDebates/openskill.py/issues/109>`_)
- model.rating() methods no longer revert to default model parameters when arguments are 0 (`#109 <https://github.com/vivekjoshy/openskill.py/issues/109>`_)


Openskill 5.0.2 (2023-08-13)
Expand All @@ -34,7 +56,7 @@ Openskill 5.0.2 (2023-08-13)
Documentation Improvements
--------------------------

- Improve SEO of Documentation (`#107 <https://github.com/OpenDebates/openskill.py/issues/107>`_)
- Improve SEO of Documentation (`#107 <https://github.com/vivekjoshy/openskill.py/issues/107>`_)


Openskill 5.0.1 (2023-08-12)
Expand All @@ -43,13 +65,13 @@ Openskill 5.0.1 (2023-08-12)
Bugfixes
--------

- Fixes philihp/openskill.js#453 (`#106 <https://github.com/OpenDebates/openskill.py/issues/106>`_)
- Fixes philihp/openskill.js#453 (`#106 <https://github.com/vivekjoshy/openskill.py/issues/106>`_)


Documentation Improvements
--------------------------

- Integrates Algolia Docsearch to Sphinx Docs (`#105 <https://github.com/OpenDebates/openskill.py/issues/105>`_)
- Integrates Algolia Docsearch to Sphinx Docs (`#105 <https://github.com/vivekjoshy/openskill.py/issues/105>`_)


Openskill 5.0.0 (2023-07-21)
Expand All @@ -58,21 +80,21 @@ Openskill 5.0.0 (2023-07-21)
Breaking Changes
----------------

- All top level functions are now methods that must be called from model once it's been initialized. (`#101 <https://github.com/OpenDebates/openskill.py/issues/101>`_)
- All top level functions are now methods that must be called from model once it's been initialized. (`#101 <https://github.com/vivekjoshy/openskill.py/issues/101>`_)


Features
--------

- Add PEP-517 and PEP-518 compliance. (`#82 <https://github.com/OpenDebates/openskill.py/issues/82>`_)
- Everything is strictly type hinted to let you use your IDE's autocomplete features. (`#101 <https://github.com/OpenDebates/openskill.py/issues/101>`_)
- Add PEP-517 and PEP-518 compliance. (`#82 <https://github.com/vivekjoshy/openskill.py/issues/82>`_)
- Everything is strictly type hinted to let you use your IDE's autocomplete features. (`#101 <https://github.com/vivekjoshy/openskill.py/issues/101>`_)


Documentation Improvements
--------------------------

- All functions, methods and classes have docstrings now. There are also LaTeX equations in
docstrings when necessary. (`#101 <https://github.com/OpenDebates/openskill.py/issues/101>`_)
docstrings when necessary. (`#101 <https://github.com/vivekjoshy/openskill.py/issues/101>`_)


Openskill 4.0.0 (2022-12-11)
Expand All @@ -81,20 +103,20 @@ Openskill 4.0.0 (2022-12-11)
Breaking Changes
----------------

- Drop support for Python 3.7 (`#80 <https://github.com/OpenDebates/openskill.py/issues/80>`_)
- Drop support for Python 3.7 (`#80 <https://github.com/vivekjoshy/openskill.py/issues/80>`_)


Features
--------

- Add support for PyPy 3.8 and 3.9 (`#80 <https://github.com/OpenDebates/openskill.py/issues/80>`_)
- Drop scipy as dependency (`#80 <https://github.com/OpenDebates/openskill.py/issues/80>`_)
- Add support for PyPy 3.8 and 3.9 (`#80 <https://github.com/vivekjoshy/openskill.py/issues/80>`_)
- Drop scipy as dependency (`#80 <https://github.com/vivekjoshy/openskill.py/issues/80>`_)


Documentation Improvements
--------------------------

- Improve SEO of Documentation (`#80 <https://github.com/OpenDebates/openskill.py/issues/80>`_)
- Improve SEO of Documentation (`#80 <https://github.com/vivekjoshy/openskill.py/issues/80>`_)


Openskill 3.3.0 (2022-12-06)
Expand All @@ -112,7 +134,7 @@ Openskill 3.2.0 (2022-12-06)
Features
--------

- Predict ranks and their odds of entire match outcome. (`#74 <https://github.com/OpenDebates/openskill.py/issues/74>`_)
- Predict ranks and their odds of entire match outcome. (`#74 <https://github.com/vivekjoshy/openskill.py/issues/74>`_)


Openskill 3.1.0 (2022-12-03)
Expand All @@ -121,7 +143,7 @@ Openskill 3.1.0 (2022-12-03)
Documentation Improvements
--------------------------

- Add more details to the documentation, fixes broken links and point a custom domain name to the docs. (`#73 <https://github.com/OpenDebates/openskill.py/issues/73>`_)
- Add more details to the documentation, fixes broken links and point a custom domain name to the docs. (`#73 <https://github.com/vivekjoshy/openskill.py/issues/73>`_)


Openskill 3.0.0 (2022-11-30)
Expand All @@ -130,7 +152,7 @@ Openskill 3.0.0 (2022-11-30)
Breaking Changes
----------------

- Modify default ``tau`` value to ``25/300`` #61 (`#61 <https://github.com/OpenDebates/openskill.py/issues/61>`_)
- Modify default ``tau`` value to ``25/300`` #61 (`#61 <https://github.com/vivekjoshy/openskill.py/issues/61>`_)


Openskill 2.5.1 (2022-11-11)
Expand All @@ -139,7 +161,7 @@ Openskill 2.5.1 (2022-11-11)
Bugfixes
--------

- Allow setting ``mu`` and ``sigma`` to 0 for ``Rating`` objects. (`#60 <https://github.com/OpenDebates/openskill.py/issues/60>`_)
- Allow setting ``mu`` and ``sigma`` to 0 for ``Rating`` objects. (`#60 <https://github.com/vivekjoshy/openskill.py/issues/60>`_)


Openskill 2.5.0 (2022-10-26)
Expand All @@ -148,13 +170,13 @@ Openskill 2.5.0 (2022-10-26)
Features
--------

- Support Python 3.11.0 Officially (`#56 <https://github.com/OpenDebates/openskill.py/issues/56>`_)
- Support Python 3.11.0 Officially (`#56 <https://github.com/vivekjoshy/openskill.py/issues/56>`_)


Bugfixes
--------

- Fixes issue where equal ranks below zero don't draw (`#54 <https://github.com/OpenDebates/openskill.py/issues/54>`_)
- Fixes issue where equal ranks below zero don't draw (`#54 <https://github.com/vivekjoshy/openskill.py/issues/54>`_)


Openskill 2.4.0 (2022-06-08)
Expand All @@ -179,7 +201,7 @@ Openskill 2.3.0 (2022-05-14)
Features
--------

- Add support for python 3.7+ (`#52 <https://github.com/OpenDebates/openskill.py/issues/52>`_)
- Add support for python 3.7+ (`#52 <https://github.com/vivekjoshy/openskill.py/issues/52>`_)


Openskill 2.2.0 (2022-03-18)
Expand All @@ -188,9 +210,9 @@ Openskill 2.2.0 (2022-03-18)
Features
--------

- ``tau`` (defaults to 0): Additive dynamics factor, which keeps a player's rating from getting stuck at a level. Normally, a player's sigma will only decrease as we gain more information about their performance. This option will put some pressure on this back up. This default will change to be sigma/100 with v3, to be more congruent with TrueSkill, but higher may make your rating system more exciting. (`#50 <https://github.com/OpenDebates/openskill.py/issues/50>`_)
- ``tau`` (defaults to 0): Additive dynamics factor, which keeps a player's rating from getting stuck at a level. Normally, a player's sigma will only decrease as we gain more information about their performance. This option will put some pressure on this back up. This default will change to be sigma/100 with v3, to be more congruent with TrueSkill, but higher may make your rating system more exciting. (`#50 <https://github.com/vivekjoshy/openskill.py/issues/50>`_)

- ``prevent_sigma_increase`` (defaults to ``False``): for a tau > 0, it is possible that a player could play someone with a low enough rating that even if they win, their ordinal rating will still go down slightly. If your players have no agency in matchmaking, it is not desirable to have a situation where a player goes down on the leaderboard even though they win. (`#50 <https://github.com/OpenDebates/openskill.py/issues/50>`_)
- ``prevent_sigma_increase`` (defaults to ``False``): for a tau > 0, it is possible that a player could play someone with a low enough rating that even if they win, their ordinal rating will still go down slightly. If your players have no agency in matchmaking, it is not desirable to have a situation where a player goes down on the leaderboard even though they win. (`#50 <https://github.com/vivekjoshy/openskill.py/issues/50>`_)


Openskill 2.1.0 (2022-03-10)
Expand All @@ -199,7 +221,7 @@ Openskill 2.1.0 (2022-03-10)
Features
--------

- Faster runtime of ``predict_win`` and ``predict_draw``. (`#48 <https://github.com/OpenDebates/openskill.py/issues/48>`_)
- Faster runtime of ``predict_win`` and ``predict_draw``. (`#48 <https://github.com/vivekjoshy/openskill.py/issues/48>`_)


Openskill 2.0.0 (2022-02-20)
Expand All @@ -208,15 +230,15 @@ Openskill 2.0.0 (2022-02-20)
Breaking Changes
----------------

- The ``rate`` function now returns ``Rating`` objects. (`#46 <https://github.com/OpenDebates/openskill.py/issues/46>`_)
- Changes ``ordinal`` to accept both ``Rating`` objects and lists or tuples of 2 floats. (`#46 <https://github.com/OpenDebates/openskill.py/issues/46>`_)
- The ``rate`` function now returns ``Rating`` objects. (`#46 <https://github.com/vivekjoshy/openskill.py/issues/46>`_)
- Changes ``ordinal`` to accept both ``Rating`` objects and lists or tuples of 2 floats. (`#46 <https://github.com/vivekjoshy/openskill.py/issues/46>`_)


Features
--------

- Add a function to predict draws. (`#45 <https://github.com/OpenDebates/openskill.py/issues/45>`_)
- ``create_rating`` now checks if the argument is the correct type. (`#46 <https://github.com/OpenDebates/openskill.py/issues/46>`_)
- Add a function to predict draws. (`#45 <https://github.com/vivekjoshy/openskill.py/issues/45>`_)
- ``create_rating`` now checks if the argument is the correct type. (`#46 <https://github.com/vivekjoshy/openskill.py/issues/46>`_)


Openskill 1.0.2 (2022-02-09)
Expand All @@ -225,7 +247,7 @@ Openskill 1.0.2 (2022-02-09)
Features
--------

- Updates scipy to 1.8.0 (`#37 <https://github.com/OpenDebates/openskill.py/issues/37>`_)
- Updates scipy to 1.8.0 (`#37 <https://github.com/vivekjoshy/openskill.py/issues/37>`_)


Openskill 1.0.1 (2022-02-04)
Expand All @@ -234,7 +256,7 @@ Openskill 1.0.1 (2022-02-04)
Features
--------

- Update development status to "Stable" (`#34 <https://github.com/OpenDebates/openskill.py/issues/34>`_)
- Update development status to "Stable" (`#34 <https://github.com/vivekjoshy/openskill.py/issues/34>`_)


Openskill 1.0.0 (2022-02-04)
Expand All @@ -243,4 +265,4 @@ Openskill 1.0.0 (2022-02-04)
Features
--------

- Capability to predict winners of match given a set of teams. (`#27 <https://github.com/OpenDebates/openskill.py/issues/27>`_)
- Capability to predict winners of match given a set of teams. (`#27 <https://github.com/vivekjoshy/openskill.py/issues/27>`_)
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ fail, please rework and resubmit your PR.

Remember to follow this
[guide](https://allcontributors.org/docs/en/bot/usage) to add yourself
to the list of [contributors](https://github.com/OpenDebates/openskill.py/blob/main/CONTRIBUTORS.md).
to the list of [contributors](https://github.com/vivekjoshy/openskill.py/blob/main/CONTRIBUTORS.md).
14 changes: 7 additions & 7 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://taven.me/"><img src="https://avatars.githubusercontent.com/u/8206808?v=4?s=100" width="100px;" alt="Vivek Joshy"/><br /><sub><b>Vivek Joshy</b></sub></a><br /><a href="https://github.com/OpenDebates/openskill.py/commits?author=vivekjoshy" title="Code">💻</a> <a href="https://github.com/OpenDebates/openskill.py/commits?author=vivekjoshy" title="Documentation">📖</a> <a href="#data-vivekjoshy" title="Data">🔣</a> <a href="#design-vivekjoshy" title="Design">🎨</a> <a href="#financial-vivekjoshy" title="Financial">💵</a> <a href="#maintenance-vivekjoshy" title="Maintenance">🚧</a> <a href="#research-vivekjoshy" title="Research">🔬</a> <a href="https://github.com/OpenDebates/openskill.py/commits?author=vivekjoshy" title="Tests">⚠️</a> <a href="https://github.com/OpenDebates/openskill.py/pulls?q=is%3Apr+reviewed-by%3Avivekjoshy" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://philihp.com/"><img src="https://avatars.githubusercontent.com/u/1247668?v=4?s=100" width="100px;" alt="‮Philihp Busby"/><br /><sub><b>‮Philihp Busby</b></sub></a><br /><a href="https://github.com/OpenDebates/openskill.py/commits?author=philihp" title="Code">💻</a> <a href="https://github.com/OpenDebates/openskill.py/commits?author=philihp" title="Documentation">📖</a> <a href="#data-philihp" title="Data">🔣</a> <a href="#research-philihp" title="Research">🔬</a> <a href="https://github.com/OpenDebates/openskill.py/commits?author=philihp" title="Tests">⚠️</a> <a href="https://github.com/OpenDebates/openskill.py/pulls?q=is%3Apr+reviewed-by%3Aphilihp" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/CalColson"><img src="https://avatars.githubusercontent.com/u/14209384?v=4?s=100" width="100px;" alt="Calvin P. Colson"/><br /><sub><b>Calvin P. Colson</b></sub></a><br /><a href="https://github.com/OpenDebates/openskill.py/commits?author=CalColson" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/martinazapletalova"><img src="https://avatars.githubusercontent.com/u/91736322?v=4?s=100" width="100px;" alt="Martina Zapletalová"/><br /><sub><b>Martina Zapletalová</b></sub></a><br /><a href="https://github.com/OpenDebates/openskill.py/issues?q=author%3Amartinazapletalova" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://erotemic.wordpress.com/"><img src="https://avatars.githubusercontent.com/u/3186211?v=4?s=100" width="100px;" alt="Jon Crall"/><br /><sub><b>Jon Crall</b></sub></a><br /><a href="https://github.com/OpenDebates/openskill.py/commits?author=Erotemic" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/bstummer"><img src="https://avatars.githubusercontent.com/u/52933850?v=4?s=100" width="100px;" alt="bstummer"/><br /><sub><b>bstummer</b></sub></a><br /><a href="https://github.com/OpenDebates/openskill.py/commits?author=bstummer" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/StephenBartos"><img src="https://avatars.githubusercontent.com/u/27743409?v=4?s=100" width="100px;" alt="Stephen Bartos"/><br /><sub><b>Stephen Bartos</b></sub></a><br /><a href="https://github.com/OpenDebates/openskill.py/commits?author=StephenBartos" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://taven.me/"><img src="https://avatars.githubusercontent.com/u/8206808?v=4?s=100" width="100px;" alt="Vivek Joshy"/><br /><sub><b>Vivek Joshy</b></sub></a><br /><a href="https://github.com/vivekjoshy/openskill.py/commits?author=vivekjoshy" title="Code">💻</a> <a href="https://github.com/vivekjoshy/openskill.py/commits?author=vivekjoshy" title="Documentation">📖</a> <a href="#data-vivekjoshy" title="Data">🔣</a> <a href="#design-vivekjoshy" title="Design">🎨</a> <a href="#financial-vivekjoshy" title="Financial">💵</a> <a href="#maintenance-vivekjoshy" title="Maintenance">🚧</a> <a href="#research-vivekjoshy" title="Research">🔬</a> <a href="https://github.com/vivekjoshy/openskill.py/commits?author=vivekjoshy" title="Tests">⚠️</a> <a href="https://github.com/vivekjoshy/openskill.py/pulls?q=is%3Apr+reviewed-by%3Avivekjoshy" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://philihp.com/"><img src="https://avatars.githubusercontent.com/u/1247668?v=4?s=100" width="100px;" alt="‮Philihp Busby"/><br /><sub><b>‮Philihp Busby</b></sub></a><br /><a href="https://github.com/vivekjoshy/openskill.py/commits?author=philihp" title="Code">💻</a> <a href="https://github.com/vivekjoshy/openskill.py/commits?author=philihp" title="Documentation">📖</a> <a href="#data-philihp" title="Data">🔣</a> <a href="#research-philihp" title="Research">🔬</a> <a href="https://github.com/vivekjoshy/openskill.py/commits?author=philihp" title="Tests">⚠️</a> <a href="https://github.com/vivekjoshy/openskill.py/pulls?q=is%3Apr+reviewed-by%3Aphilihp" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/CalColson"><img src="https://avatars.githubusercontent.com/u/14209384?v=4?s=100" width="100px;" alt="Calvin P. Colson"/><br /><sub><b>Calvin P. Colson</b></sub></a><br /><a href="https://github.com/vivekjoshy/openskill.py/commits?author=CalColson" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/martinazapletalova"><img src="https://avatars.githubusercontent.com/u/91736322?v=4?s=100" width="100px;" alt="Martina Zapletalová"/><br /><sub><b>Martina Zapletalová</b></sub></a><br /><a href="https://github.com/vivekjoshy/openskill.py/issues?q=author%3Amartinazapletalova" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://erotemic.wordpress.com/"><img src="https://avatars.githubusercontent.com/u/3186211?v=4?s=100" width="100px;" alt="Jon Crall"/><br /><sub><b>Jon Crall</b></sub></a><br /><a href="https://github.com/vivekjoshy/openskill.py/commits?author=Erotemic" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/bstummer"><img src="https://avatars.githubusercontent.com/u/52933850?v=4?s=100" width="100px;" alt="bstummer"/><br /><sub><b>bstummer</b></sub></a><br /><a href="https://github.com/vivekjoshy/openskill.py/commits?author=bstummer" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/StephenBartos"><img src="https://avatars.githubusercontent.com/u/27743409?v=4?s=100" width="100px;" alt="Stephen Bartos"/><br /><sub><b>Stephen Bartos</b></sub></a><br /><a href="https://github.com/vivekjoshy/openskill.py/commits?author=StephenBartos" title="Code">💻</a></td>
</tr>
</tbody>
<tfoot>
Expand Down
Loading

0 comments on commit ca3be34

Please sign in to comment.