From c7e349e73d05d3199bf8e78fd1a6ddc5bafa97cf Mon Sep 17 00:00:00 2001 From: Jethro Kuan Date: Thu, 3 Dec 2020 08:17:34 +0800 Subject: [PATCH] docs: default_root_path -> default_root_dir (#4942) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: default_root_path -> default_root_dir * Apply suggestions from code review * fix Co-authored-by: Carlos Mocholí * update notebook Co-authored-by: Jethro Kuan Co-authored-by: Jirka Borovec Co-authored-by: Carlos Mocholí Co-authored-by: Rohit Gupta --- docs/source/trainer.rst | 4 ++-- notebooks/05-trainer-flags-overview.ipynb | 2 +- pytorch_lightning/trainer/properties.py | 1 - 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/source/trainer.rst b/docs/source/trainer.rst index d49011837f..92b6b29017 100644 --- a/docs/source/trainer.rst +++ b/docs/source/trainer.rst @@ -612,10 +612,10 @@ 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. -Example:: +.. testcode:: # default used by the Trainer - trainer = Trainer(default_root_path=os.getcwd()) + trainer = Trainer(default_root_dir=os.getcwd()) distributed_backend ^^^^^^^^^^^^^^^^^^^ diff --git a/notebooks/05-trainer-flags-overview.ipynb b/notebooks/05-trainer-flags-overview.ipynb index a3d06abe1b..6413e8239b 100644 --- a/notebooks/05-trainer-flags-overview.ipynb +++ b/notebooks/05-trainer-flags-overview.ipynb @@ -2152,7 +2152,7 @@ "outputs": [], "source": [ "# default used by the Trainer\n", - "trainer = pl.Trainer(default_root_path=os.getcwd())\n", + "trainer = pl.Trainer(default_root_dir=os.getcwd())\n", "\n", "trainer.fit(model, train_loader, val_loader)" ] diff --git a/pytorch_lightning/trainer/properties.py b/pytorch_lightning/trainer/properties.py index 09022d5b37..ba94ec2d95 100644 --- a/pytorch_lightning/trainer/properties.py +++ b/pytorch_lightning/trainer/properties.py @@ -48,7 +48,6 @@ class TrainerProperties(ABC): limit_val_batches: int _default_root_dir: str _weights_save_path: str - default_root_path: str accelerator_backend: Accelerator logger: LightningLoggerBase model_connector: ModelConnector