Skip to content

Commit 2782a00

Browse files
committed
Updated docs versionadded/versionchanged to 0.5.4
1 parent b092e3b commit 2782a00

7 files changed

Lines changed: 11 additions & 11 deletions

File tree

ignite/base/mixins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class ResettableHandler(metaclass=ABCMeta):
1313
Subclasses must implement the :meth:`reset` method to clear any accumulated
1414
state, typically at the beginning of a training run.
1515
16-
.. versionadded:: 0.6.0
16+
.. versionadded:: 0.5.4
1717
"""
1818

1919
@abstractmethod

ignite/handlers/early_stopping.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def score_function(engine):
5252
# Note: the handler is attached to an *Evaluator* (runs one epoch on validation dataset).
5353
evaluator.add_event_handler(Events.COMPLETED, handler)
5454
55-
.. versionchanged:: 0.6.0
55+
.. versionchanged:: 0.5.4
5656
Added `mode` parameter to support minimization in addition to maximization.
5757
Added `min_delta_mode` parameter to support both absolute and relative improvements.
5858
@@ -132,7 +132,7 @@ def __call__(self, engine: Engine) -> None:
132132
def reset(self) -> None:
133133
"""Reset the early stopping state, including the counter and best score.
134134
135-
.. versionadded:: 0.6.0
135+
.. versionadded:: 0.5.4
136136
"""
137137
self.counter = 0
138138
self.best_score = None
@@ -161,7 +161,7 @@ def attach( # type: ignore[override]
161161
reset_event: The event on ``reset_engine`` that triggers the handler state reset.
162162
Default is :attr:`~ignite.engine.events.Events.STARTED`.
163163
164-
.. versionadded:: 0.6.0
164+
.. versionadded:: 0.5.4
165165
"""
166166
engine.add_event_handler(event, self)
167167

ignite/metrics/fairness/accuracy_difference.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class SubgroupAccuracyDifference(SubgroupDifference):
6565
6666
1.0
6767
68-
.. versionadded:: 0.6.0
68+
.. versionadded:: 0.5.4
6969
7070
References:
7171
- Verma & Rubin, `Fairness Definitions Explained

ignite/metrics/fairness/base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ class SubgroupMetric(_SubgroupBase):
8787
form expected by the metric. Default is ``(y_pred, y, group_labels)``.
8888
device: specifies which device updates are accumulated on.
8989
90-
.. versionadded:: 0.6.0
90+
.. versionadded:: 0.5.4
9191
"""
9292

9393
def compute(self) -> dict[Any, Any]:
@@ -110,7 +110,7 @@ class SubgroupDifference(_SubgroupBase):
110110
output_transform: a callable that is used to transform the engine output.
111111
device: specifies the computation device.
112112
113-
.. versionadded:: 0.6.0
113+
.. versionadded:: 0.5.4
114114
"""
115115

116116
def compute(self) -> float:

ignite/metrics/fairness/demographic_parity.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class SelectionRate(_BaseClassification):
4040
4141
tensor([0.5000, 0.5000])
4242
43-
.. versionadded:: 0.6.0
43+
.. versionadded:: 0.5.4
4444
"""
4545

4646
_state_dict_all_req_keys = ("_num_positives", "_num_examples")
@@ -164,7 +164,7 @@ class DemographicParityDifference(SubgroupDifference):
164164
165165
1.0
166166
167-
.. versionadded:: 0.6.0
167+
.. versionadded:: 0.5.4
168168
169169
References:
170170
- Verma & Rubin, `Fairness Definitions Explained

ignite/metrics/matthews_corrcoef.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class MatthewsCorrCoef(EpochMetric):
7272
7373
-0.33...
7474
75-
.. versionadded:: 0.6.0
75+
.. versionadded:: 0.5.4
7676
7777
"""
7878

ignite/metrics/rec_sys/hitrate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class HitRate(Metric):
9797
9898
[0.0, 0.5, 0.5, 0.5]
9999
100-
.. versionadded:: 0.6.0
100+
.. versionadded:: 0.5.4
101101
"""
102102

103103
required_output_keys = ("y_pred", "y")

0 commit comments

Comments
 (0)