From 4f9b5ed7123ba3c0a5bd25051930b93ae80183eb Mon Sep 17 00:00:00 2001 From: BanzaiTokyo Date: Sat, 24 Oct 2020 02:10:57 +0200 Subject: [PATCH 1/2] removes styling of function descriptions as requested in #1256 --- examples/contrib/cifar100_amp_benchmark/utils.py | 1 + examples/mnist/mnist_with_tensorboard_on_tpu.py | 1 + ignite/contrib/engines/common.py | 8 ++++++++ 3 files changed, 10 insertions(+) diff --git a/examples/contrib/cifar100_amp_benchmark/utils.py b/examples/contrib/cifar100_amp_benchmark/utils.py index 12befd03d711..98aed43b8cbb 100644 --- a/examples/contrib/cifar100_amp_benchmark/utils.py +++ b/examples/contrib/cifar100_amp_benchmark/utils.py @@ -9,6 +9,7 @@ def get_train_eval_loaders(path, batch_size=256): """Setup the dataflow: + - load CIFAR100 train and test datasets - setup train/test image transforms - horizontally flipped randomly and augmented using cutout. diff --git a/examples/mnist/mnist_with_tensorboard_on_tpu.py b/examples/mnist/mnist_with_tensorboard_on_tpu.py index 84441ee12386..f19afd8806b5 100644 --- a/examples/mnist/mnist_with_tensorboard_on_tpu.py +++ b/examples/mnist/mnist_with_tensorboard_on_tpu.py @@ -1,6 +1,7 @@ """ MNIST example with training and validation monitoring using Tensorboard on TPU Requirements: + - PyTorch >= 1.5 - PyTorch XLA >= 1.5 - Tensorboard: `pip install tensorflow` (or just install tensorboard without the rest of tensorflow) diff --git a/ignite/contrib/engines/common.py b/ignite/contrib/engines/common.py index 44409765c4fa..88c637545c7a 100644 --- a/ignite/contrib/engines/common.py +++ b/ignite/contrib/engines/common.py @@ -49,6 +49,7 @@ def setup_common_training_handlers( **kwargs: Any ): """Helper method to setup trainer with common handlers (it also supports distributed configuration): + - :class:`~ignite.handlers.TerminateOnNan` - handler to setup learning rate scheduling - :class:`~ignite.handlers.ModelCheckpoint` @@ -312,6 +313,7 @@ def setup_tb_logging( **kwargs: Any ): """Method to setup TensorBoard logging on trainer and a list of evaluators. Logged metrics are: + - Training metrics, e.g. running average loss values - Learning rate(s) - Evaluation metrics @@ -343,6 +345,7 @@ def setup_visdom_logging( **kwargs: Any ): """Method to setup Visdom logging on trainer and a list of evaluators. Logged metrics are: + - Training metrics, e.g. running average loss values - Learning rate(s) - Evaluation metrics @@ -373,6 +376,7 @@ def setup_mlflow_logging( **kwargs: Any ): """Method to setup MLflow logging on trainer and a list of evaluators. Logged metrics are: + - Training metrics, e.g. running average loss values - Learning rate(s) - Evaluation metrics @@ -403,6 +407,7 @@ def setup_neptune_logging( **kwargs: Any ): """Method to setup Neptune logging on trainer and a list of evaluators. Logged metrics are: + - Training metrics, e.g. running average loss values - Learning rate(s) - Evaluation metrics @@ -433,6 +438,7 @@ def setup_wandb_logging( **kwargs: Any ): """Method to setup WandB logging on trainer and a list of evaluators. Logged metrics are: + - Training metrics, e.g. running average loss values - Learning rate(s) - Evaluation metrics @@ -463,6 +469,7 @@ def setup_plx_logging( **kwargs: Any ): """Method to setup Polyaxon logging on trainer and a list of evaluators. Logged metrics are: + - Training metrics, e.g. running average loss values - Learning rate(s) - Evaluation metrics @@ -493,6 +500,7 @@ def setup_trains_logging( **kwargs: Any ): """Method to setup Trains logging on trainer and a list of evaluators. Logged metrics are: + - Training metrics, e.g. running average loss values - Learning rate(s) - Evaluation metrics From df1e7bf063f679670c042be694a1103f5c87b054 Mon Sep 17 00:00:00 2001 From: BanzaiTokyo Date: Sun, 25 Oct 2020 01:07:32 +0200 Subject: [PATCH 2/2] reverts modifications to the example files --- examples/contrib/cifar100_amp_benchmark/utils.py | 1 - examples/mnist/mnist_with_tensorboard_on_tpu.py | 1 - 2 files changed, 2 deletions(-) diff --git a/examples/contrib/cifar100_amp_benchmark/utils.py b/examples/contrib/cifar100_amp_benchmark/utils.py index 98aed43b8cbb..12befd03d711 100644 --- a/examples/contrib/cifar100_amp_benchmark/utils.py +++ b/examples/contrib/cifar100_amp_benchmark/utils.py @@ -9,7 +9,6 @@ def get_train_eval_loaders(path, batch_size=256): """Setup the dataflow: - - load CIFAR100 train and test datasets - setup train/test image transforms - horizontally flipped randomly and augmented using cutout. diff --git a/examples/mnist/mnist_with_tensorboard_on_tpu.py b/examples/mnist/mnist_with_tensorboard_on_tpu.py index f19afd8806b5..84441ee12386 100644 --- a/examples/mnist/mnist_with_tensorboard_on_tpu.py +++ b/examples/mnist/mnist_with_tensorboard_on_tpu.py @@ -1,7 +1,6 @@ """ MNIST example with training and validation monitoring using Tensorboard on TPU Requirements: - - PyTorch >= 1.5 - PyTorch XLA >= 1.5 - Tensorboard: `pip install tensorflow` (or just install tensorboard without the rest of tensorflow)