From e19086c2b593f101efd7710bab5a9a56daa701c6 Mon Sep 17 00:00:00 2001 From: vfdev Date: Tue, 19 Jun 2018 01:00:39 +0200 Subject: [PATCH] Nit: update docs (#196) --- ignite/engine/__init__.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ignite/engine/__init__.py b/ignite/engine/__init__.py index 4ec69c7e5a4..a943a8dc945 100644 --- a/ignite/engine/__init__.py +++ b/ignite/engine/__init__.py @@ -14,10 +14,10 @@ def create_supervised_trainer(model, optimizer, loss_fn, device=None): Factory function for creating a trainer for supervised models Args: - model (torch.nn.Module): the model to train - optimizer (torch.optim.Optimizer): the optimizer to use + model (`torch.nn.Module`): the model to train + optimizer (`torch.optim.Optimizer`): the optimizer to use loss_fn (torch.nn loss function): the loss function to use - device (optional): device type specification (default: None) + device (str, optional): device type specification (default: None). Applies to both model and batches. Returns: @@ -44,9 +44,9 @@ def create_supervised_evaluator(model, metrics={}, device=None): Factory function for creating an evaluator for supervised models Args: - model (torch.nn.Module): the model to train - metrics (dict of str: Metric): a map of metric names to Metrics - device (optional): device type specification (default: None) + model (`torch.nn.Module`): the model to train + metrics (dict of str - :class:`ignite.metrics.Metric`): a map of metric names to Metrics + device (str, optional): device type specification (default: None). Applies to both model and batches. Returns: