Skip to content

Commit 7b812c0

Browse files
committed
Change docs versionadded to 0.4.7
- additionally fixed docs for bleu and rouge
1 parent 936579f commit 7b812c0

15 files changed

+28
-26
lines changed

ignite/contrib/handlers/clearml_logger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ def global_step_transform(*args, **kwargs):
299299
def global_step_transform(engine, event_name):
300300
return engine.state.get_event_attrib_value(event_name)
301301
302-
.. versionchanged:: 0.5.0
302+
.. versionchanged:: 0.4.7
303303
accepts an optional list of `state_attributes`
304304
"""
305305

ignite/contrib/handlers/mlflow_logger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ def global_step_transform(*args, **kwargs):
213213
def global_step_transform(engine, event_name):
214214
return engine.state.get_event_attrib_value(event_name)
215215
216-
.. versionchanged:: 0.5.0
216+
.. versionchanged:: 0.4.7
217217
accepts an optional list of `state_attributes`
218218
"""
219219

ignite/contrib/handlers/neptune_logger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ def global_step_transform(*args, **kwargs):
321321
def global_step_transform(engine, event_name):
322322
return engine.state.get_event_attrib_value(event_name)
323323
324-
.. versionchanged:: 0.5.0
324+
.. versionchanged:: 0.4.7
325325
accepts an optional list of `state_attributes`
326326
"""
327327

ignite/contrib/handlers/polyaxon_logger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ def global_step_transform(*args, **kwargs):
221221
def global_step_transform(engine, event_name):
222222
return engine.state.get_event_attrib_value(event_name)
223223
224-
.. versionchanged:: 0.5.0
224+
.. versionchanged:: 0.4.7
225225
accepts an optional list of `state_attributes`
226226
"""
227227

ignite/contrib/handlers/tensorboard_logger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ def global_step_transform(*args, **kwargs):
269269
def global_step_transform(engine, event_name):
270270
return engine.state.get_event_attrib_value(event_name)
271271
272-
.. versionchanged:: 0.5.0
272+
.. versionchanged:: 0.4.7
273273
accepts an optional list of `state_attributes`
274274
"""
275275

ignite/contrib/handlers/tqdm_logger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ class ProgressBar(BaseLogger):
100100
Due to `tqdm notebook bugs <https://github.com/tqdm/tqdm/issues/594>`_, bar format may be needed to be set
101101
to an empty string value.
102102
103-
.. versionchanged:: 0.5.0
103+
.. versionchanged:: 0.4.7
104104
`attach` now accepts an optional list of `state_attributes`
105105
106106
"""

ignite/contrib/handlers/visdom_logger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ class VisdomLogger(BaseLogger):
135135
output_transform=lambda loss: {"loss": loss}
136136
)
137137
138-
.. versionchanged:: 0.5.0
138+
.. versionchanged:: 0.4.7
139139
accepts an optional list of `state_attributes`
140140
"""
141141

ignite/contrib/handlers/wandb_logger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ def global_step_transform(*args, **kwargs):
261261
def global_step_transform(engine, event_name):
262262
return engine.state.get_event_attrib_value(event_name)
263263
264-
.. versionchanged:: 0.5.0
264+
.. versionchanged:: 0.4.7
265265
accepts an optional list of `state_attributes`
266266
"""
267267

ignite/distributed/auto.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ def auto_optim(optimizer: Optimizer, **kwargs: Any) -> Optimizer:
263263
.. versionchanged:: 0.4.2
264264
Added Horovod distributed optimizer.
265265
266-
.. versionchanged:: 0.5.0
266+
.. versionchanged:: 0.4.7
267267
Added kwargs to ``idist.auto_optim``.
268268
"""
269269
bnd = idist.backend()

ignite/engine/__init__.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def supervised_training_step(
8686
trainer = Engine(update_fn)
8787
8888
.. versionadded:: 0.4.5
89-
.. versionchanged:: 0.5.0
89+
.. versionchanged:: 0.4.7
9090
Added Gradient Accumulation.
9191
"""
9292

@@ -159,7 +159,7 @@ def supervised_training_step_amp(
159159
trainer = Engine(update_fn)
160160
161161
.. versionadded:: 0.4.5
162-
.. versionchanged:: 0.5.0
162+
.. versionchanged:: 0.4.7
163163
Added Gradient Accumulation.
164164
"""
165165

@@ -242,7 +242,7 @@ def supervised_training_step_apex(
242242
trainer = Engine(update_fn)
243243
244244
.. versionadded:: 0.4.5
245-
.. versionchanged:: 0.5.0
245+
.. versionchanged:: 0.4.7
246246
Added Gradient Accumulation.
247247
"""
248248

@@ -318,7 +318,7 @@ def supervised_training_step_tpu(
318318
trainer = Engine(update_fn)
319319
320320
.. versionadded:: 0.4.5
321-
.. versionchanged:: 0.5.0
321+
.. versionchanged:: 0.4.7
322322
Added Gradient Accumulation argument for all supervised training methods.
323323
"""
324324
try:
@@ -449,7 +449,7 @@ def create_supervised_trainer(
449449
- Added ``amp_mode`` argument for automatic mixed precision.
450450
- Added ``scaler`` argument for gradient scaling.
451451
452-
.. versionchanged:: 0.5.0
452+
.. versionchanged:: 0.4.7
453453
Added Gradient Accumulation argument for all supervised training methods.
454454
"""
455455

ignite/handlers/checkpoint.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ class Checkpoint(Serializable):
259259
- Checkpoint can save model with same filename.
260260
- Added ``greater_or_equal`` argument.
261261
262-
.. versionchanged:: 0.5.0
262+
.. versionchanged:: 0.4.7
263263
264264
- `score_name` can be used to define `score_function` automatically without providing `score_function`.
265265
- `save_handler` automatically saves to disk if path to directory is provided.

ignite/handlers/param_scheduler.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class BaseParamScheduler(metaclass=ABCMeta):
2424
save_history: whether to log the parameter values to
2525
`engine.state.param_history`, (default=False).
2626
27-
.. versionadded:: 0.5.0
27+
.. versionadded:: 0.4.7
2828
2929
"""
3030

ignite/handlers/state_param_scheduler.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class StateParamScheduler(BaseParamScheduler):
1919
More precisely, whatever the state of the engine (newly created or used by another scheduler) the scheduler
2020
sets defined absolute values.
2121
22-
.. versionadded:: 0.5.0
22+
.. versionadded:: 0.4.7
2323
2424
"""
2525

@@ -143,7 +143,7 @@ def __call__(self, event_index):
143143
144144
engine.run([0] * 8, max_epochs=2)
145145
146-
.. versionadded:: 0.5.0
146+
.. versionadded:: 0.4.7
147147
148148
"""
149149

@@ -195,7 +195,7 @@ class PiecewiseLinearStateScheduler(StateParamScheduler):
195195
# the end of the iterations.
196196
#
197197
198-
.. versionadded:: 0.5.0
198+
.. versionadded:: 0.4.7
199199
"""
200200

201201
def __init__(
@@ -284,7 +284,7 @@ class ExpStateScheduler(StateParamScheduler):
284284
285285
engine.run([0] * 8, max_epochs=2)
286286
287-
.. versionadded:: 0.5.0
287+
.. versionadded:: 0.4.7
288288
289289
"""
290290

@@ -332,7 +332,7 @@ class StepStateScheduler(StateParamScheduler):
332332
333333
engine.run([0] * 8, max_epochs=10)
334334
335-
.. versionadded:: 0.5.0
335+
.. versionadded:: 0.4.7
336336
337337
"""
338338

@@ -381,7 +381,7 @@ class MultiStepStateScheduler(StateParamScheduler):
381381
382382
engine.run([0] * 8, max_epochs=10)
383383
384-
.. versionadded:: 0.5.0
384+
.. versionadded:: 0.4.7
385385
386386
"""
387387

ignite/metrics/nlp/bleu.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,10 @@ class Bleu(Metric):
117117
print(m.compute())
118118
119119
.. versionadded:: 0.4.5
120-
.. versionchanged:: 0.5.0
121-
added ``average`` option to handle micro and macro averaging modes.
120+
.. versionchanged:: 0.4.7
121+
122+
- ``update`` method has changed and now works on batch of inputs.
123+
- added ``average`` option to handle micro and macro averaging modes.
122124
"""
123125

124126
def __init__(

ignite/metrics/nlp/rouge.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,8 @@ class Rouge(Metric):
357357
# 'Rouge-2-F': 0.4}
358358
359359
.. versionadded:: 0.4.5
360-
.. versionchanged:: 0.5.0
361-
Changed input type to work on batch of inputs
360+
.. versionchanged:: 0.4.7
361+
``update`` method has changed and now works on batch of inputs.
362362
"""
363363

364364
def __init__(

0 commit comments

Comments
 (0)