docs: default_root_path -> default_root_dir (#4942)

* docs: default_root_path -> default_root_dir

* Apply suggestions from code review

* fix

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

* update notebook

Co-authored-by: Jethro Kuan <jethro.kuan@bytedance.com>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
This commit is contained in:
Jethro Kuan 2020-12-03 08:17:34 +08:00 committed by GitHub
parent 7b7d4bb86d
commit c7e349e73d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 4 deletions

View File

@ -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
^^^^^^^^^^^^^^^^^^^

View File

@ -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)"
]

View File

@ -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