[doc] [runtime env] Add hint for pip install command line options (#…

…39183) A common user request is how to handle required pip install flags when migrating from manual CLI installation to specifying it in a runtime_env. This is actually supported, you just have to specify a requirements.txt file for the runtime_env pip field. This PR updates the doc with instructions on how to do it. --------- Signed-off-by: Archit Kulkarni <[email protected]> Co-authored-by: angelinalg <[email protected]>
ray-project · Sep 6, 2023 · 7e37264 · 7e37264
1 parent d856d3f
commit 7e37264
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/doc/source/ray-core/handling-dependencies.rst b/doc/source/ray-core/handling-dependencies.rst
@@ -266,6 +266,7 @@ However, using runtime environments you can dynamically specify packages to be a
 
 
 You may also specify your ``pip`` dependencies either via a Python list or a local ``requirements.txt`` file.
+Consider specifying a ``requirements.txt`` file when your ``pip install`` command requires options such as ``--extra-index-url`` or ``--find-links``; see `<https://pip.pypa.io/en/stable/reference/requirements-file-format/#>`_ for details.
 Alternatively, you can specify a ``conda`` environment, either as a Python dictionary or via a local ``environment.yml`` file. This conda environment can include ``pip`` packages.
 For details, head to the :ref:`API Reference <runtime-environments-api-ref>`.