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

[air/docs] Remove experimental features page, add github issue instead #36950

Merged
merged 2 commits into from
Jun 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion doc/source/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ parts:
- file: ray-air/computer-vision
- file: ray-air/examples/serving_guide
- file: ray-air/deployment
- file: ray-air/experimental-features
- file: ray-air/examples/index
sections:
- file: ray-air/examples/opt_deepspeed_batch_inference
Expand Down
133 changes: 0 additions & 133 deletions doc/source/ray-air/experimental-features.rst

This file was deleted.

23 changes: 3 additions & 20 deletions doc/source/ray-air/user-guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ Please also see the :ref:`Ray Tune environment variables <tune-env-vars>`.
including internal code paths. Otherwise, abbreviated tracebacks that only show user code
are printed. Defaults to 0 (disabled).
- **RAY_AIR_NEW_OUTPUT**: If set to 0, this disables
the :ref:`experimental new console output <air-experimental-new-output>`.
the `experimental new console output <https://github.com/ray-project/ray/issues/36949>`_.
- **RAY_AIR_RICH_LAYOUT**: If set to 1, this enables
the :ref:`stick table layout <air-experimental-rich>`
the `stick table layout <https://github.com/ray-project/ray/issues/36949>`_
(only available for Ray Tune).

.. _air-multi-tenancy:
Expand All @@ -129,21 +129,4 @@ instead.
If you still want to do this, refer to
the
:ref:`Ray Tune multi-tenancy docs <tune-multi-tenancy>`
for potential pitfalls.

.. _air-experimental-overview:

Experimental features in Ray 2.5+
---------------------------------
Starting in Ray 2.5, some experimental
features are enabled by default.

Experimental features are enabled to allow for feedback
from users. Every experimental feature can be disabled
by setting an environment variable. Some features are
not ready for general testing and can only be *enabled* using an
environment variable.

Please see the :ref:`experimental features <air-experimental-features>`
page for more details on the current features and how to enable
or disable them.
for potential pitfalls.
2 changes: 1 addition & 1 deletion doc/source/tune/api/env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ These are the environment variables Ray Tune currently considers:
* **TUNE_DISABLE_DATED_SUBDIR**: Ray Tune automatically adds a date string to experiment
directories when the name is not specified explicitly or the trainable isn't passed
as a string. Setting this environment variable to ``1`` disables adding these date strings.
* **TUNE_NEW_EXECUTION**: Disable :ref:`Ray Tune's new execution engine <air-experimental-execution>`.
* **TUNE_NEW_EXECUTION**: Disable `Ray Tune's new execution engine <https://github.com/ray-project/ray/issues/36949>`_.
* **TUNE_DISABLE_STRICT_METRIC_CHECKING**: When you report metrics to Tune via
``session.report()`` and passed a ``metric`` parameter to ``Tuner()``, a scheduler,
or a search algorithm, Tune will error
Expand Down
8 changes: 4 additions & 4 deletions python/ray/tune/tune.py
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,7 @@ class and registered trainables.
"[output] This uses the legacy output and progress reporter, "
"as Ray client is not supported by the new engine. "
"For more information, see "
"https://docs.ray.io/en/master/ray-air/experimental-features.html"
"https://github.com/ray-project/ray/issues/36949"
)

remote_run = ray.remote(num_cpus=0)(run)
Expand Down Expand Up @@ -658,7 +658,7 @@ class and registered trainables.
"[output] This uses the legacy output and progress reporter, "
"as Jupyter notebooks are not supported by the new engine, yet. "
"For more information, please see "
"https://docs.ray.io/en/master/ray-air/experimental-features.html"
"https://github.com/ray-project/ray/issues/36949"
)
air_verbosity = None

Expand All @@ -668,7 +668,7 @@ class and registered trainables.
f"{air_verbosity}. To disable the new output and use the legacy "
f"output engine, set the environment variable RAY_AIR_NEW_OUTPUT=0. "
f"For more information, please see "
f"https://docs.ray.io/en/master/ray-air/experimental-features.html"
f"https://github.com/ray-project/ray/issues/36949"
)
# Disable old output engine
set_verbosity(0)
Expand Down Expand Up @@ -1226,7 +1226,7 @@ def run_experiments(
"[output] This uses the legacy output and progress reporter, "
"as Ray client is not supported by the new engine. "
"For more information, see "
"https://docs.ray.io/en/master/ray-air/experimental-features.html"
"https://github.com/ray-project/ray/issues/36949"
)
remote_run = ray.remote(num_cpus=0)(run_experiments)

Expand Down
2 changes: 1 addition & 1 deletion python/ray/tune/tuner.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ def __init__(
"[output] This uses the legacy output and progress reporter, "
"as Ray client is not supported by the new engine. "
"For more information, see "
"https://docs.ray.io/en/master/ray-air/experimental-features.html"
"https://github.com/ray-project/ray/issues/36949"
)

if _tuner_internal:
Expand Down