From 3c02ab96b182b71263bf058fa67004defdaf0578 Mon Sep 17 00:00:00 2001 From: rohitgr7 Date: Wed, 29 Sep 2021 13:38:28 +0530 Subject: [PATCH 01/13] enable_chekpointing --- docs/source/common/hyperparameters.rst | 2 +- docs/source/common/trainer.rst | 68 +++++++++---------- .../trainer/connectors/callback_connector.py | 29 +++++--- pytorch_lightning/trainer/trainer.py | 10 ++- tests/deprecated_api/test_remove_1-7.py | 5 ++ 5 files changed, 68 insertions(+), 46 deletions(-) diff --git a/docs/source/common/hyperparameters.rst b/docs/source/common/hyperparameters.rst index 1781a26a9189f..41a99e022ae95 100644 --- a/docs/source/common/hyperparameters.rst +++ b/docs/source/common/hyperparameters.rst @@ -201,7 +201,7 @@ To recap, add ALL possible trainer flags to the argparser and init the ``Trainer trainer = Trainer.from_argparse_args(hparams) # or if you need to pass in callbacks - trainer = Trainer.from_argparse_args(hparams, checkpoint_callback=..., callbacks=[...]) + trainer = Trainer.from_argparse_args(hparams, enable_checkpointing=..., callbacks=[...]) ---------- diff --git a/docs/source/common/trainer.rst b/docs/source/common/trainer.rst index 9e7de8f928730..10668b2939fc1 100644 --- a/docs/source/common/trainer.rst +++ b/docs/source/common/trainer.rst @@ -528,6 +528,38 @@ Example:: checkpoint_callback ^^^^^^^^^^^^^^^^^^^ +Deprecated: This has been renamed ``enable_checkpointing``. + +default_root_dir +^^^^^^^^^^^^^^^^ + +.. raw:: html + + + +| + +Default path for logs and weights when no logger or +:class:`pytorch_lightning.callbacks.ModelCheckpoint` callback passed. On +certain clusters you might want to separate where logs and checkpoints are +stored. If you don't then use this argument for convenience. Paths can be local +paths or remote paths such as `s3://bucket/path` or 'hdfs://path/'. Credentials +will need to be set up to use remote filepaths. + +.. testcode:: + + # default used by the Trainer + trainer = Trainer(default_root_dir=os.getcwd()) + +distributed_backend +^^^^^^^^^^^^^^^^^^^ +Deprecated: This has been renamed ``accelerator``. + +enable_checkpointing +^^^^^^^^^^^^^^^^^^^^ + .. raw:: html