Skip to content

Commit

Permalink
[Documentation] Fix quotes for windows installations (#19859)
Browse files Browse the repository at this point in the history
* [Documentation] Fix quotes for windows installations

* update

* formatting
  • Loading branch information
pcmoritz authored Oct 29, 2021
1 parent 1fe9f33 commit 0a5942d
Show file tree
Hide file tree
Showing 17 changed files with 24 additions and 24 deletions.
6 changes: 3 additions & 3 deletions doc/source/cluster/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,19 @@ Before we start, you will need to install some Python dependencies as follows:

.. code-block:: shell
$ pip install -U 'ray[default]' boto3
$ pip install -U "ray[default]" boto3
.. group-tab:: Azure

.. code-block:: shell
$ pip install -U 'ray[default]' azure-cli azure-core
$ pip install -U "ray[default]" azure-cli azure-core
.. group-tab:: GCP

.. code-block:: shell
$ pip install -U 'ray[default]' google-api-python-client
$ pip install -U "ray[default]" google-api-python-client
Next, if you're not set up to use your cloud provider from the command line, you'll have to configure your credentials:

Expand Down
2 changes: 1 addition & 1 deletion doc/source/data/dataset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Creating Datasets

.. tip::

Run ``pip install ray[data]`` to get started!
Run ``pip install "ray[data]"`` to get started!

Get started by creating Datasets from synthetic data using ``ray.data.range()`` and ``ray.data.from_items()``. Datasets can hold either plain Python objects (schema is a Python type), or Arrow records (schema is Arrow).

Expand Down
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Ray provides Python, Java, and *EXPERIMENTAL* C++ API. And Ray uses Tasks (funct
.. code-block:: shell
pip install ray[cpp]
pip install "ray[cpp]"
mkdir ray-template && ray cpp --generate-bazel-project-template-to ray-template
| - The project template comes with a simple example application. You can try this example out in 2 ways:
Expand Down
8 changes: 4 additions & 4 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ You can install the latest official version of Ray as follows.
pip install -U ray # minimal install
# To install Ray with support for the dashboard + cluster launcher, run
# `pip install -U 'ray[default]'`
# `pip install -U "ray[default]"`
To install Ray libraries:

.. code-block:: bash
pip install -U ray[tune] # installs Ray + dependencies for Ray Tune
pip install -U ray[rllib] # installs Ray + dependencies for Ray RLlib
pip install -U ray[serve] # installs Ray + dependencies for Ray Serve
pip install -U "ray[tune]" # installs Ray + dependencies for Ray Tune
pip install -U "ray[rllib]" # installs Ray + dependencies for Ray RLlib
pip install -U "ray[serve]" # installs Ray + dependencies for Ray Serve
.. _install-nightlies:

Expand Down
2 changes: 1 addition & 1 deletion doc/source/ray-dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To use the dashboard, first install Ray with the proper dependencies:

.. code-block:: bash
pip install 'ray[default]'
pip install "ray[default]"
You can access the dashboard through its default URL, **localhost:8265**.
(Note that the port number increases if the default port is not available).
Expand Down
2 changes: 1 addition & 1 deletion doc/source/ray-metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ First, install Ray with the proper dependencies:

.. code-block:: bash
pip install 'ray[default]'
pip install "ray[default]"
Ray exposes its metrics in Prometheus format. This allows us to easily scrape them using Prometheus.

Expand Down
4 changes: 2 additions & 2 deletions doc/source/ray-overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Tune Quick Start

.. code-block:: bash
$ pip install 'ray[tune]'
$ pip install "ray[tune]"
This example runs a small grid search with an iterative training function.
Expand All @@ -196,7 +196,7 @@ RLlib Quick Start
.. code-block:: bash
pip install tensorflow # or tensorflow-gpu
pip install ray[rllib]
pip install "ray[rllib]"
.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion doc/source/rllib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ RLlib has extra dependencies on top of ``ray``. First, you'll need to install ei

.. code-block:: bash
pip install 'ray[rllib]'
pip install "ray[rllib]"
Then, you can try out training in the following equivalent ways:

Expand Down
2 changes: 1 addition & 1 deletion doc/source/tune/_tutorials/tune-sklearn.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
Ray Tune's Scikit-learn APIs allows you to easily leverage Bayesian Optimization, HyperBand, and other cutting edge tuning techniques by simply toggling a few parameters. It also supports and provides examples for many other frameworks with Scikit-Learn wrappers such as Skorch (Pytorch), KerasClassifiers (Keras), and XGBoostClassifiers (XGBoost).
Run ``pip install ray[tune] tune-sklearn`` to get started.
Run ``pip install "ray[tune]" tune-sklearn`` to get started.
Walkthrough
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/source/tune/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Tune is a Python library for experiment execution and hyperparameter tuning at a
Quick Start
-----------

To run this example, install the following: ``pip install 'ray[tune]'``.
To run this example, install the following: ``pip install "ray[tune]"``.

This example runs a parallel grid search to optimize an example objective function.

Expand Down
2 changes: 1 addition & 1 deletion python/ray/autoscaler/_private/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ def _bootstrap_config(config: Dict[str, Any],
cli_logger.abort(
"Not all Ray autoscaler dependencies were found. "
"In Ray 1.4+, the Ray CLI, autoscaler, and dashboard will "
"only be usable via `pip install 'ray[default]'`. Please "
"only be usable via `pip install \"ray[default]\"`. Please "
"update your install command.")
resolved_config = provider_cls.bootstrap_config(config)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def _get_http_response(self, request):
logger.exception(
"Not all Ray Autoscaler dependencies were found. "
"In Ray 1.4+, the Ray CLI, autoscaler, and dashboard will "
"only be usable via `pip install 'ray[default]'`. Please "
"only be usable via `pip install \"ray[default]\"`. Please "
"update your install command.")
raise

Expand Down
2 changes: 1 addition & 1 deletion python/ray/autoscaler/_private/staroid/node_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def _try_import_requests():
"'requests' was not found, which is needed for "
"this cluster configuration. "
"Download this dependency by running `pip install requests` "
"or `pip install 'ray[default]'`.") from None
"or `pip install \"ray[default]\"`.") from None
return requests


Expand Down
2 changes: 1 addition & 1 deletion python/ray/serve/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from ray.serve.config import HTTPOptions
except ModuleNotFoundError as e:
e.msg += (
". You can run `pip install 'ray[serve]'` to install all Ray Serve"
". You can run `pip install \"ray[serve]\"` to install all Ray Serve"
" dependencies.")
raise e

Expand Down
4 changes: 2 additions & 2 deletions python/ray/tune/logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ def _init(self):
except ImportError:
if log_once("tbx-install"):
logger.info(
"pip install 'ray[tune]' to see TensorBoard files.")
"pip install \"ray[tune]\" to see TensorBoard files.")
raise
self._file_writer = SummaryWriter(self.logdir, flush_secs=30)
self.last_result = None
Expand Down Expand Up @@ -603,7 +603,7 @@ def __init__(self):
except ImportError:
if log_once("tbx-install"):
logger.info(
"pip install 'ray[tune]' to see TensorBoard files.")
"pip install \"ray[tune]\" to see TensorBoard files.")
raise
self._trial_writer: Dict["Trial", SummaryWriter] = {}
self._trial_result: Dict["Trial", Dict] = {}
Expand Down
2 changes: 1 addition & 1 deletion python/ray/util/client/server/proxier.py
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ def _create_runtime_env(self, serialized_runtime_env: str,
"runtime_env feature were found on the "
"cluster. To install the required "
"dependencies, please run `pip install "
"'ray[default]'` on all cluster nodes.")
"\"ray[default]\"` on all cluster nodes.")
create_env_request = runtime_env_agent_pb2.CreateRuntimeEnvRequest(
serialized_runtime_env=serialized_runtime_env,
job_id=f"ray_client_server_{specific_server.port}".encode("utf-8"))
Expand Down
2 changes: 1 addition & 1 deletion src/ray/raylet/agent_manager.cc
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ void AgentManager::CreateRuntimeEnv(
if (!should_start_agent_) {
RAY_LOG(ERROR) << "Not all required Ray dependencies for the runtime_env "
"feature were found. To install the required dependencies, "
<< "please run `pip install 'ray[default]'`.";
<< "please run `pip install \"ray[default]\"`.";
// Execute the callback after the currently executing callback finishes. Otherwise
// the task may be erased from the dispatch queue during the queue iteration in
// ClusterTaskManager::DispatchScheduledTasksToWorkers(), invalidating the iterator
Expand Down

0 comments on commit 0a5942d

Please sign in to comment.