You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ci/lint/pydoclint-baseline.txt
-2Lines changed: 0 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1477,8 +1477,6 @@ python/ray/serve/api.py
1477
1477
DOC103: Function `start`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [**kwargs: ].
1478
1478
DOC201: Function `get_replica_context` does not have a return section in docstring
1479
1479
DOC201: Function `ingress` does not have a return section in docstring
1480
-
DOC101: Function `run_many`: Docstring contains fewer arguments than in function signature.
1481
-
DOC103: Function `run_many`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [_local_testing_mode: bool].
1482
1480
DOC101: Function `run`: Docstring contains fewer arguments than in function signature.
1483
1481
DOC103: Function `run`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [_local_testing_mode: bool].
1484
1482
DOC101: Function `multiplexed`: Docstring contains fewer arguments than in function signature.
Copy file name to clipboardExpand all lines: doc/source/data/joining-data.rst
-9Lines changed: 0 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,15 +54,6 @@ Ray Data provides the following levers to allow tuning the performance of joins
54
54
- Note that, `num_partitions * partition_size_hint` should ideally be approximating actual dataset size, ie `partition_size_hint` could be estimated as dataset size divided by `num_partitions` (assuming relatively evenly sized partitions)
55
55
- However, in cases when dataset partitioning is expected to be heavily skewed `partition_size_hint` should approximate largest partition to prevent Out-of-Memory (OOM) errors
56
56
57
-
.. note:: Be mindful that by default Ray reserves only 30% of the memory for its Object Store. This is recommended to be set at least to ***50%*** for all
58
-
Ray Data workloads, but especially so for ones utilizing joins.
59
-
60
-
To configure Object Store to be 50%, add to your image:
Copy file name to clipboardExpand all lines: doc/source/data/performance-tips.rst
-3Lines changed: 0 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -441,9 +441,6 @@ You can configure execution options with the global DataContext. The options are
441
441
object_store_memory=10e9,
442
442
)
443
443
444
-
.. note::
445
-
Be mindful that by default Ray reserves only 30% of the memory for its Object Store. This is recommended to be set at least to ***50%*** for all Ray Data workloads.
Copy file name to clipboardExpand all lines: doc/source/ray-core/handling-dependencies.rst
+33-18Lines changed: 33 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -490,8 +490,8 @@ API Reference
490
490
491
491
The ``runtime_env`` is a Python dictionary or a Python class :class:`ray.runtime_env.RuntimeEnv <ray.runtime_env.RuntimeEnv>` including one or more of the following fields:
492
492
493
-
- ``working_dir`` (str): Specifies the working directory for the Ray workers. This must either be (1) an local existing directory with total size at most 500 MiB, (2) a local existing zipped file with total unzipped size at most 500 MiB (Note: ``excludes`` has no effect), or (3) a URI to a remotely-stored zip file containing the working directory for your job (no file size limit is enforced by Ray). See :ref:`remote-uris` for details.
494
-
The specified directory will be downloaded to each node on the cluster, and Ray workers will be started in their node's copy of this directory.
493
+
- ``working_dir`` (str): Specifies the working directory for the Ray workers. This must either be (1) a local existing directory with total size at most 500 MiB, (2) a local existing archive file (``.zip``, ``.tar.gz``, or ``.tgz``) with total uncompressed size at most 500 MiB (Note: ``excludes`` has no effect), or (3) a URI to a remotely-stored archive (``.zip``, ``.tar.gz``, or ``.tgz``) containing the working directory for your job (no file size limit is enforced by Ray). See :ref:`remote-uris` for details.
494
+
The specified directory is downloaded to each node on the cluster, and Ray workers start in their node's copy of this directory.
495
495
496
496
- Examples
497
497
@@ -503,6 +503,8 @@ The ``runtime_env`` is a Python dictionary or a Python class :class:`ray.runtime
503
503
504
504
- ``"s3://path/to/my_dir.zip"``
505
505
506
+
- ``"s3://path/to/my_dir.tar.gz"``
507
+
506
508
Note: Setting a local directory per-task or per-actor is currently unsupported; it can only be set per-job (i.e., in ``ray.init()``).
507
509
508
510
Note: By default, if the local directory contains a ``.gitignore`` and/or ``.rayignore`` file, the specified files are not uploaded to the cluster. To disable the ``.gitignore`` from being considered, set ``RAY_RUNTIME_ENV_IGNORE_GITIGNORE=1`` on the machine doing the uploading.
@@ -512,7 +514,7 @@ The ``runtime_env`` is a Python dictionary or a Python class :class:`ray.runtime
512
514
Note: If the local directory contains symbolic links, Ray follows the links and the files they point to are uploaded to the cluster.
513
515
514
516
- ``py_modules`` (List[str|module]): Specifies Python modules to be available for import in the Ray workers. (For more ways to specify packages, see also the ``pip`` and ``conda`` fields below.)
515
-
Each entry must be either (1) a path to a local file or directory, (2) a URI to a remote zipor wheel file (see :ref:`remote-uris` for details), (3) a Python module object, or (4) a path to a local `.whl` file.
517
+
Each entry must be either (1) a path to a local file or directory, (2) a URI to a remote archive (``.zip``, ``.tar.gz``, ``.tgz``) or wheel (``.whl``) file (see :ref:`remote-uris` for details), (3) a Python module object, or (4) a path to a local ``.whl`` file.
516
518
517
519
- Examples of entries in the list:
518
520
@@ -818,25 +820,31 @@ If you want to specify this directory as a local path, your ``runtime_env`` dict
Suppose instead you want to host your files in your ``/some_path/example_dir`` directory remotely and provide a remote URI.
821
-
You would need to first compress the ``example_dir`` directory into a zip file.
823
+
You need to first compress the ``example_dir`` directory into a ``.zip`` or ``.tar.gz`` archive.
822
824
823
-
There should be no other files or directories at the top level of the zip file, other than ``example_dir``.
824
-
You can use the following command in the Terminal to do this:
825
+
There should be no other files or directories at the top level of the archive, other than ``example_dir``.
826
+
You can use one of the following commands in the Terminal:
825
827
826
828
.. code-block:: bash
827
829
828
830
cd /some_path
829
-
zip -r zip_file_name.zip example_dir
831
+
# Using zip:
832
+
zip -r archive.zip example_dir
833
+
# Using tar.gz:
834
+
tar -czf archive.tar.gz example_dir
830
835
831
-
Note that this command must be run from the *parent directory* of the desired ``working_dir`` to ensure that the resulting zip file contains a single top-level directory.
832
-
In general, the zip file's name and the top-level directory's name can be anything.
833
-
The top-level directory's contents will be used as the ``working_dir`` (or ``py_module``).
836
+
Run this command from the *parent directory* of the desired ``working_dir`` to ensure that the resulting archive contains a single top-level directory.
837
+
In general, the archive's name and the top-level directory's name can be anything.
838
+
The top-level directory's contents are used as the ``working_dir`` (or ``py_module``).
834
839
835
-
You can check that the zip file contains a single top-level directory by running the following command in the Terminal:
840
+
You can check that the archive contains a single top-level directory by running one of the following commands in the Terminal:
836
841
837
842
.. code-block:: bash
838
843
839
-
zipinfo -1 zip_file_name.zip
844
+
# For zip:
845
+
zipinfo -1 archive.zip
846
+
# For tar.gz:
847
+
tar -tzf archive.tar.gz
840
848
# example_dir/
841
849
# example_dir/my_file_1.txt
842
850
# example_dir/subdir/my_file_2.txt
@@ -849,15 +857,22 @@ Your ``runtime_env`` dictionary should contain:
Check for hidden files and metadata directories in zipped dependencies.
855
-
You can inspect a zip file's contents by running the ``zipinfo -1 zip_file_name.zip`` command in the Terminal.
856
-
Some zipping methods can cause hidden files or metadata directories to appear in the zip file at the top level.
857
-
To avoid this, use the ``zip -r`` command directly on the directory you want to compress from its parent's directory. For example, if you have a directory structure such as: ``a/b`` and you want to compress ``b``, issue the ``zip -r b`` command from the directory ``a.``
858
-
If Ray detects more than a single directory at the top level, it will use the entire zip file instead of the top-level directory, which may lead to unexpected behavior.
869
+
Check for hidden files and metadata directories in archived dependencies.
870
+
You can inspect an archive's contents by running ``zipinfo -1 archive.zip`` or ``tar -tzf archive.tar.gz`` in the Terminal.
871
+
Some archiving methods can cause hidden files or metadata directories to appear at the top level.
872
+
To avoid this, use ``zip -r`` or ``tar -czf`` directly on the directory you want to compress from its parent's directory. For example, if you have a directory structure such as: ``a/b`` and you want to compress ``b``, issue the command from the directory ``a``.
873
+
If Ray detects more than a single directory at the top level, it uses the entire archive instead of the top-level directory, which may lead to unexpected behavior.
859
874
860
-
Currently, four types of remote URIs are supported for hosting ``working_dir`` and ``py_modules`` packages:
875
+
Remote URIs support ``.zip``, ``.tar.gz``, and ``.tgz`` archive formats. Four types of remote URIs are supported for hosting ``working_dir`` and ``py_modules`` packages:
861
876
862
877
- ``HTTPS``: ``HTTPS`` refers to URLs that start with ``https``.
863
878
These are particularly useful because remote Git providers (e.g. GitHub, Bitbucket, GitLab, etc.) use ``https`` URLs as download links for repository archives.
0 commit comments