diff --git a/CHANGELOG.md b/CHANGELOG.md index 01076b46ec073..a25271ed3d2a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -308,6 +308,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). - Deprecated Accelerator collective API `barrier`, `broadcast`, and `all_gather`, call `TrainingTypePlugin` collective API directly ([#9677](https://github.com/PyTorchLightning/pytorch-lightning/pull/9677)) +- Deprecated `checkpoint_callback` from the `Trainer` constructor in favour of `enable_checkpointing` ([#9754](https://github.com/PyTorchLightning/pytorch-lightning/pull/9754)) + + - Deprecated the `LightningModule.on_post_move_to_device` method ([#9525](https://github.com/PyTorchLightning/pytorch-lightning/pull/9525)) 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 e8f78864b1ddf..42615383b5c1f 100644 --- a/docs/source/common/trainer.rst +++ b/docs/source/common/trainer.rst @@ -528,6 +528,38 @@ Example:: checkpoint_callback ^^^^^^^^^^^^^^^^^^^ +Deprecated: This has been deprecated in v1.5 and will be removed in v.17. Please use ``enable_checkpointing`` instead. + +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