From 70b68637ffbffcda054753f589f2353254dff76e Mon Sep 17 00:00:00 2001 From: Felonious-Spellfire Date: Tue, 9 Aug 2022 14:32:47 -0700 Subject: [PATCH 1/3] Added note about custom base images --- .../core_api/lightning_work/compute_content.rst | 9 +++++++++ .../glossary/build_config/build_config_basic.rst | 11 ++++++++++- .../build_config/build_config_intermediate.rst | 11 ++++++++++- 3 files changed, 29 insertions(+), 2 deletions(-) diff --git a/docs/source-app/core_api/lightning_work/compute_content.rst b/docs/source-app/core_api/lightning_work/compute_content.rst index 68853c949e12c..37f5a9576f4bf 100644 --- a/docs/source-app/core_api/lightning_work/compute_content.rst +++ b/docs/source-app/core_api/lightning_work/compute_content.rst @@ -22,6 +22,15 @@ a :class:`~lightning_app.utilities.packaging.cloud_compute.CloudCompute` to your # Run on a fast multi-GPU machine (see specs below) MyCustomWork(cloud_compute=L.CloudCompute("gpu-fast-multi")) +.. warning:: + Custom base images are not supported with the default-cpu. For example: + + .. code-block:: py + + class MyWork(LightningWork): + def __init__(self): + super().__init__(cloud_build_config=BuildConfig(image="my-custom-image")) # no cloud compute, for example default work + Here is the full list of supported machine names: diff --git a/docs/source-app/glossary/build_config/build_config_basic.rst b/docs/source-app/glossary/build_config/build_config_basic.rst index c3e3ae8c6ffe2..09a5ca2e03704 100644 --- a/docs/source-app/glossary/build_config/build_config_basic.rst +++ b/docs/source-app/glossary/build_config/build_config_basic.rst @@ -35,7 +35,6 @@ When the LightningWork starts up, it will pick up the requirements file if prese .. note:: This only applies when running in the cloud. The requirements.txt files get ignored when running locally. - ---- *********************************** @@ -58,3 +57,13 @@ Instead of listing the requirements in a file, you can also pass them to the Lig .. note:: The build config only applies when running in the cloud and gets ignored otherwise. A local build config is currently not supported. + +.. warning:: + Custom base images are not supported with the default-cpu. For example: + + .. code-block:: py + + class MyWork(LightningWork): + def __init__(self): + super().__init__(cloud_build_config=BuildConfig(image="my-custom-image")) # no cloud compute, for example default work + diff --git a/docs/source-app/glossary/build_config/build_config_intermediate.rst b/docs/source-app/glossary/build_config/build_config_intermediate.rst index 174f472facb8e..46f9819c761f5 100644 --- a/docs/source-app/glossary/build_config/build_config_intermediate.rst +++ b/docs/source-app/glossary/build_config/build_config_intermediate.rst @@ -42,7 +42,16 @@ If you need to install additional system packages or run other configuration ste # Can also be combined with extra requirements self.cloud_build_config = CustomBuildConfig(requirements=["torchmetrics"]) - .. note:: - When you need to execute commands or install tools that require more privileges than the current user has, you can use ``sudo`` without needing to provide a password, e.g., when installing system packages. - The build config only applies when running in the cloud and gets ignored otherwise. A local build config is currently not supported. + +.. warning:: + Custom base images are not supported with the default-cpu. For example: + + .. code-block:: py + + class MyWork(LightningWork): + def __init__(self): + super().__init__(cloud_build_config=BuildConfig(image="my-custom-image")) # no cloud compute, for example default work + From 6927780bef26d9b1d32c594a6f235aa70cd67b30 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 9 Aug 2022 21:36:12 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source-app/glossary/build_config/build_config_basic.rst | 1 - .../glossary/build_config/build_config_intermediate.rst | 1 - 2 files changed, 2 deletions(-) diff --git a/docs/source-app/glossary/build_config/build_config_basic.rst b/docs/source-app/glossary/build_config/build_config_basic.rst index 09a5ca2e03704..0651529e3a7bf 100644 --- a/docs/source-app/glossary/build_config/build_config_basic.rst +++ b/docs/source-app/glossary/build_config/build_config_basic.rst @@ -66,4 +66,3 @@ Instead of listing the requirements in a file, you can also pass them to the Lig class MyWork(LightningWork): def __init__(self): super().__init__(cloud_build_config=BuildConfig(image="my-custom-image")) # no cloud compute, for example default work - diff --git a/docs/source-app/glossary/build_config/build_config_intermediate.rst b/docs/source-app/glossary/build_config/build_config_intermediate.rst index 46f9819c761f5..9f30f6e6df77f 100644 --- a/docs/source-app/glossary/build_config/build_config_intermediate.rst +++ b/docs/source-app/glossary/build_config/build_config_intermediate.rst @@ -54,4 +54,3 @@ If you need to install additional system packages or run other configuration ste class MyWork(LightningWork): def __init__(self): super().__init__(cloud_build_config=BuildConfig(image="my-custom-image")) # no cloud compute, for example default work - From 16b9d69373ef225ccdd802665a6fe4b5f0cfc20d Mon Sep 17 00:00:00 2001 From: awaelchli Date: Sat, 26 Nov 2022 22:52:02 +0100 Subject: [PATCH 3/3] update name --- docs/source-app/core_api/lightning_work/compute_content.rst | 2 +- docs/source-app/glossary/build_config/build_config_basic.rst | 2 +- .../glossary/build_config/build_config_intermediate.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source-app/core_api/lightning_work/compute_content.rst b/docs/source-app/core_api/lightning_work/compute_content.rst index 533154cc2880f..8c5064875270d 100644 --- a/docs/source-app/core_api/lightning_work/compute_content.rst +++ b/docs/source-app/core_api/lightning_work/compute_content.rst @@ -23,7 +23,7 @@ a :class:`~lightning_app.utilities.packaging.cloud_compute.CloudCompute` to your MyCustomWork(cloud_compute=L.CloudCompute("gpu-fast-multi")) .. warning:: - Custom base images are not supported with the default-cpu. For example: + Custom base images are not supported with the default CPU cloud compute. For example: .. code-block:: py diff --git a/docs/source-app/glossary/build_config/build_config_basic.rst b/docs/source-app/glossary/build_config/build_config_basic.rst index 0651529e3a7bf..dcff9d6c9bc8a 100644 --- a/docs/source-app/glossary/build_config/build_config_basic.rst +++ b/docs/source-app/glossary/build_config/build_config_basic.rst @@ -59,7 +59,7 @@ Instead of listing the requirements in a file, you can also pass them to the Lig The build config only applies when running in the cloud and gets ignored otherwise. A local build config is currently not supported. .. warning:: - Custom base images are not supported with the default-cpu. For example: + Custom base images are not supported with the default CPU cloud compute. For example: .. code-block:: py diff --git a/docs/source-app/glossary/build_config/build_config_intermediate.rst b/docs/source-app/glossary/build_config/build_config_intermediate.rst index 9f30f6e6df77f..914ef07bf6ef4 100644 --- a/docs/source-app/glossary/build_config/build_config_intermediate.rst +++ b/docs/source-app/glossary/build_config/build_config_intermediate.rst @@ -47,7 +47,7 @@ If you need to install additional system packages or run other configuration ste - The build config only applies when running in the cloud and gets ignored otherwise. A local build config is currently not supported. .. warning:: - Custom base images are not supported with the default-cpu. For example: + Custom base images are not supported with the default CPU cloud compute. For example: .. code-block:: py