Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added note about custom base images #14125

Merged
merged 7 commits into from
Nov 26, 2022
9 changes: 9 additions & 0 deletions docs/source-app/core_api/lightning_work/compute_content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 cloud compute. 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:

Expand Down
10 changes: 9 additions & 1 deletion docs/source-app/glossary/build_config/build_config_basic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.


----

***********************************
Expand All @@ -58,3 +57,12 @@ 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 cloud compute. 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
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,15 @@ 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 cloud compute. 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