Skip to content

Commit 4255991

Browse files
pintaoz-awspintaoz
and
pintaoz
authored
Fix documentation for local mode (#5026)
Co-authored-by: pintaoz <[email protected]>
1 parent 133c61d commit 4255991

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/overview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1958,15 +1958,15 @@ Make sure to have a Compose Version compatible with your Docker Engine installat
19581958
Local mode configuration
19591959
========================
19601960

1961-
The local mode uses a YAML configuration file located at ``~/.sagemaker/config.yaml`` to define the default values that are automatically passed to the ``config`` attribute of ``LocalSession``. This is an example of the configuration, for the full schema, see `sagemaker.config.config_schema.SAGEMAKER_PYTHON_SDK_LOCAL_MODE_CONFIG_SCHEMA <https://github.com/aws/sagemaker-python-sdk/blob/master/src/sagemaker/config/config_schema.py>`_.
1961+
The local mode uses a YAML configuration file located at ``${user_config_directory}/sagemaker/config.yaml`` to define the default values that are automatically passed to the ``config`` attribute of ``LocalSession``. This is an example of the configuration, for the full schema, see `sagemaker.config.config_schema.SAGEMAKER_PYTHON_SDK_LOCAL_MODE_CONFIG_SCHEMA <https://github.com/aws/sagemaker-python-sdk/blob/master/src/sagemaker/config/config_schema.py>`_.
19621962

19631963
.. code:: yaml
19641964
19651965
local:
19661966
local_code: true # Using everything locally
19671967
region_name: "us-west-2" # Name of the region
19681968
container_config: # Additional docker container config
1969-
shm_size: "128M
1969+
shm_size: "128M"
19701970
19711971
If you want to keep everything local, and not use Amazon S3 either, you can enable "local code" in one of two ways:
19721972

0 commit comments

Comments
 (0)