Skip to content

Commit c71eebb

Browse files
committed
Update documentation
1 parent d35d591 commit c71eebb

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

doc/overview.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1560,9 +1560,20 @@ You can install necessary dependencies for this feature using pip.
15601560
Additionally, Local Mode also requires Docker Compose V2. Follow the guidelines in https://docs.docker.com/compose/install/ to install.
15611561
Make sure to have a Compose Version compatible with your Docker Engine installation. Check Docker Engine release notes https://docs.docker.com/engine/release-notes to find a compatible version.
15621562

1563-
If you want to keep everything local, and not use Amazon S3 either, you can enable "local code" in one of two ways:
1563+
Local mode configuration
1564+
========================
15641565

1565-
- Create a file at ``~/.sagemaker/config.yaml`` that contains:
1566+
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>`_.
1567+
1568+
.. code:: yaml
1569+
1570+
local:
1571+
local_code: true # Using everything locally
1572+
region_name: "us-west-2" # Name of the region
1573+
container_config: # Additional docker container config
1574+
shm_size: "128M
1575+
1576+
If you want to keep everything local, and not use Amazon S3 either, you can enable "local code" in one of two ways:
15661577
15671578
.. code:: yaml
15681579
@@ -1583,6 +1594,9 @@ If you want to keep everything local, and not use Amazon S3 either, you can enab
15831594
.. note::
15841595
If you enable "local code," then you cannot use the ``dependencies`` parameter in your estimator or model.
15851596

1597+
Activating local mode by ``instance_type`` argument
1598+
====================================================
1599+
15861600
We can take the example in `Using Estimators <#using-estimators>`__ , and use either ``local`` or ``local_gpu`` as the instance type.
15871601

15881602
.. code:: python

0 commit comments

Comments
 (0)