Skip to content

Commit

Permalink
Change docs versionadded to 0.4.7
Browse files Browse the repository at this point in the history
- additionally fixed docs for bleu and rouge
  • Loading branch information
vfdev-5 committed Oct 12, 2021
1 parent 936579f commit 7b812c0
Show file tree
Hide file tree
Showing 15 changed files with 28 additions and 26 deletions.
2 changes: 1 addition & 1 deletion ignite/contrib/handlers/clearml_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ def global_step_transform(*args, **kwargs):
def global_step_transform(engine, event_name):
return engine.state.get_event_attrib_value(event_name)
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
accepts an optional list of `state_attributes`
"""

Expand Down
2 changes: 1 addition & 1 deletion ignite/contrib/handlers/mlflow_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def global_step_transform(*args, **kwargs):
def global_step_transform(engine, event_name):
return engine.state.get_event_attrib_value(event_name)
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
accepts an optional list of `state_attributes`
"""

Expand Down
2 changes: 1 addition & 1 deletion ignite/contrib/handlers/neptune_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ def global_step_transform(*args, **kwargs):
def global_step_transform(engine, event_name):
return engine.state.get_event_attrib_value(event_name)
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
accepts an optional list of `state_attributes`
"""

Expand Down
2 changes: 1 addition & 1 deletion ignite/contrib/handlers/polyaxon_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ def global_step_transform(*args, **kwargs):
def global_step_transform(engine, event_name):
return engine.state.get_event_attrib_value(event_name)
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
accepts an optional list of `state_attributes`
"""

Expand Down
2 changes: 1 addition & 1 deletion ignite/contrib/handlers/tensorboard_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ def global_step_transform(*args, **kwargs):
def global_step_transform(engine, event_name):
return engine.state.get_event_attrib_value(event_name)
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
accepts an optional list of `state_attributes`
"""

Expand Down
2 changes: 1 addition & 1 deletion ignite/contrib/handlers/tqdm_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ class ProgressBar(BaseLogger):
Due to `tqdm notebook bugs <https://github.com/tqdm/tqdm/issues/594>`_, bar format may be needed to be set
to an empty string value.
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
`attach` now accepts an optional list of `state_attributes`
"""
Expand Down
2 changes: 1 addition & 1 deletion ignite/contrib/handlers/visdom_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ class VisdomLogger(BaseLogger):
output_transform=lambda loss: {"loss": loss}
)
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
accepts an optional list of `state_attributes`
"""

Expand Down
2 changes: 1 addition & 1 deletion ignite/contrib/handlers/wandb_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ def global_step_transform(*args, **kwargs):
def global_step_transform(engine, event_name):
return engine.state.get_event_attrib_value(event_name)
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
accepts an optional list of `state_attributes`
"""

Expand Down
2 changes: 1 addition & 1 deletion ignite/distributed/auto.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ def auto_optim(optimizer: Optimizer, **kwargs: Any) -> Optimizer:
.. versionchanged:: 0.4.2
Added Horovod distributed optimizer.
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
Added kwargs to ``idist.auto_optim``.
"""
bnd = idist.backend()
Expand Down
10 changes: 5 additions & 5 deletions ignite/engine/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ def supervised_training_step(
trainer = Engine(update_fn)
.. versionadded:: 0.4.5
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
Added Gradient Accumulation.
"""

Expand Down Expand Up @@ -159,7 +159,7 @@ def supervised_training_step_amp(
trainer = Engine(update_fn)
.. versionadded:: 0.4.5
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
Added Gradient Accumulation.
"""

Expand Down Expand Up @@ -242,7 +242,7 @@ def supervised_training_step_apex(
trainer = Engine(update_fn)
.. versionadded:: 0.4.5
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
Added Gradient Accumulation.
"""

Expand Down Expand Up @@ -318,7 +318,7 @@ def supervised_training_step_tpu(
trainer = Engine(update_fn)
.. versionadded:: 0.4.5
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
Added Gradient Accumulation argument for all supervised training methods.
"""
try:
Expand Down Expand Up @@ -449,7 +449,7 @@ def create_supervised_trainer(
- Added ``amp_mode`` argument for automatic mixed precision.
- Added ``scaler`` argument for gradient scaling.
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
Added Gradient Accumulation argument for all supervised training methods.
"""

Expand Down
2 changes: 1 addition & 1 deletion ignite/handlers/checkpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ class Checkpoint(Serializable):
- Checkpoint can save model with same filename.
- Added ``greater_or_equal`` argument.
.. versionchanged:: 0.5.0
.. versionchanged:: 0.4.7
- `score_name` can be used to define `score_function` automatically without providing `score_function`.
- `save_handler` automatically saves to disk if path to directory is provided.
Expand Down
2 changes: 1 addition & 1 deletion ignite/handlers/param_scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class BaseParamScheduler(metaclass=ABCMeta):
save_history: whether to log the parameter values to
`engine.state.param_history`, (default=False).
.. versionadded:: 0.5.0
.. versionadded:: 0.4.7
"""

Expand Down
12 changes: 6 additions & 6 deletions ignite/handlers/state_param_scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class StateParamScheduler(BaseParamScheduler):
More precisely, whatever the state of the engine (newly created or used by another scheduler) the scheduler
sets defined absolute values.
.. versionadded:: 0.5.0
.. versionadded:: 0.4.7
"""

Expand Down Expand Up @@ -143,7 +143,7 @@ def __call__(self, event_index):
engine.run([0] * 8, max_epochs=2)
.. versionadded:: 0.5.0
.. versionadded:: 0.4.7
"""

Expand Down Expand Up @@ -195,7 +195,7 @@ class PiecewiseLinearStateScheduler(StateParamScheduler):
# the end of the iterations.
#
.. versionadded:: 0.5.0
.. versionadded:: 0.4.7
"""

def __init__(
Expand Down Expand Up @@ -284,7 +284,7 @@ class ExpStateScheduler(StateParamScheduler):
engine.run([0] * 8, max_epochs=2)
.. versionadded:: 0.5.0
.. versionadded:: 0.4.7
"""

Expand Down Expand Up @@ -332,7 +332,7 @@ class StepStateScheduler(StateParamScheduler):
engine.run([0] * 8, max_epochs=10)
.. versionadded:: 0.5.0
.. versionadded:: 0.4.7
"""

Expand Down Expand Up @@ -381,7 +381,7 @@ class MultiStepStateScheduler(StateParamScheduler):
engine.run([0] * 8, max_epochs=10)
.. versionadded:: 0.5.0
.. versionadded:: 0.4.7
"""

Expand Down
6 changes: 4 additions & 2 deletions ignite/metrics/nlp/bleu.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,10 @@ class Bleu(Metric):
print(m.compute())
.. versionadded:: 0.4.5
.. versionchanged:: 0.5.0
added ``average`` option to handle micro and macro averaging modes.
.. versionchanged:: 0.4.7
- ``update`` method has changed and now works on batch of inputs.
- added ``average`` option to handle micro and macro averaging modes.
"""

def __init__(
Expand Down
4 changes: 2 additions & 2 deletions ignite/metrics/nlp/rouge.py
Original file line number Diff line number Diff line change
Expand Up @@ -357,8 +357,8 @@ class Rouge(Metric):
# 'Rouge-2-F': 0.4}
.. versionadded:: 0.4.5
.. versionchanged:: 0.5.0
Changed input type to work on batch of inputs
.. versionchanged:: 0.4.7
``update`` method has changed and now works on batch of inputs.
"""

def __init__(
Expand Down

0 comments on commit 7b812c0

Please sign in to comment.