Commit graph

2450 commits

Author SHA1 Message Date
Dmitri Gekhtman
06f7f33a4e
[docs] KubeRay config guide and autoscaling discussion (#27504)
This PR adds a guide on RayCluster configuration and a page of discussion about autoscaling.

    Signed-off-by: Dmitri Gekhtman <dmitri.m.gekhtman@gmail.com>
2022-08-05 13:11:28 -07:00
Sihan Wang
5fe586b881
[Serve/Doc] Add deployment migration guide (#27408)
Co-authored-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
2022-08-05 14:28:48 -05:00
Richard Liaw
4629a3a649
[air/docs] Update Trainer documentation (#27481)
Co-authored-by: xwjiang2010 <xwjiang2010@gmail.com>
Co-authored-by: Kai Fricke <kai@anyscale.com>
Co-authored-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Eric Liang <ekhliang@gmail.com>
2022-08-05 11:21:19 -07:00
Cade Daniel
f94a2fe166
[docs][Ray Clusters] New Ray Clusters getting started page. (#27391)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2022-08-05 10:21:56 -07:00
zcin
22db41c21a
[Serve][doc] Modify and Combine Tensorflow, Pytorch, Sklearn Tutorials (#26817) 2022-08-05 11:55:31 -05:00
zcin
04c7ccacf1
[Serve][Doc] Moves Serve REST API and Serve CLI API into separate subpages (#26914) 2022-08-05 11:51:53 -05:00
zcin
8a9d994dd0
[serve] Integrate and Document Bring-Your-Own Gradio Applications (#26403)
Integration between Ray Serve and Gradio. Users of Gradio can wrap their Gradio app in a Serve deployment by using `GradioIngress`, and scale it up through more replicas or more CPU/GPU resources.
2022-08-05 11:31:00 -05:00
Jiajun Yao
b11d3061d8
[Doc] Core getting started page revamp (#27303)
- Add a calculating pi example to getting started page.
- Move installing ray c++ to the installation page.

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
2022-08-04 23:36:16 -07:00
Archit Kulkarni
1714d0266b
[Doc] [Serve] Refresh code for "monitoring" for 2.0 (#27400) 2022-08-04 20:10:12 -07:00
Bill Chambers
73bc572405
[AIR/docs] Adding Source Libraries (#27518)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2022-08-04 15:56:40 -07:00
Philipp Moritz
ef260702a2
[docs] Better defaults for installing Ray (#27500) 2022-08-04 11:20:08 -07:00
Bill Chambers
19dc19a2c5
Fix Ray Air Docs Install (#27501) 2022-08-04 10:47:10 -07:00
shrekris-anyscale
11abc89746
[Serve] [Docs] Use dashboard agent port in REST API documentation (#27450) 2022-08-04 10:24:57 -07:00
Philipp Moritz
64fc1155b7
[docs] K8s docs intro polish and KubeRay architecture diagram (#27488)
* Save work

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* Update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* consistency

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* fixes

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* simplify

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* fix

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* wording

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>
2022-08-04 10:07:15 -07:00
Richard Liaw
b2cd34cc5c
[air] Remove checkpoint user guide and update key concepts and docstring (#27455) 2022-08-04 08:55:26 -07:00
xwjiang2010
8d5c07b781
[air/train/docs] Add trainer user guide and update trainer docs (#27389)
This PR adds a user guide to AIR for using Ray Train. It provides a high level overview of the trainers and removes redundant sections.

The main file to review is here: doc/source/ray-air/trainer.rst.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
Signed-off-by: Kai Fricke <kai@anyscale.com>

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Co-authored-by: Kai Fricke <kai@anyscale.com>
2022-08-04 13:59:50 +01:00
Eric Liang
cd9cabcadf
[docs] Change data tagline to "Distributed Data Preprocessing" (#27434) 2022-08-03 16:57:07 -07:00
Eric Liang
67a306f92f
[docs] Update colors and styling of ray diagrams (#27474) 2022-08-03 16:49:25 -07:00
Eric Liang
340f0960d6
[docs] Improve the AIR introductory page (#27347) 2022-08-03 16:04:04 -07:00
Balaji Veeramani
fd381927c1
[AIR] Add optional mode parameter and make size parameter optional (#27295)
1. If a user reads a folder with grayscale and color images, ImageFolderDatasource errors.
2. There's no way to retain image shapes.

Co-authored-by: Clark Zinzow <clarkzinzow@gmail.com>
2022-08-03 13:20:46 -07:00
Eric Liang
c7056309c4
[docs] Revamp README and Ray intro doc page (#27405)
This PR revamps and aligns the README and Ray intro doc page:

New "What is Ray" diagram that introduces AIR vs Ray core (diagram TBD finalized, this is the working placeholder)
Update the description of Ray
Link out to the user guides for key libraries and key concepts
Remove old / broken links, as well as the inline library descriptions from the README
2022-08-03 13:19:00 -07:00
Archit Kulkarni
9f0d8e364d
[Doc] Update Serve architecture doc for 2.0 (#26861)
- Move autoscaling architecture from autoscaling page to architecture page
- Update architecture page
    - Remove "Router" actor
    - Update description of ServeHandle
    - Update defaults about HTTPproxy (default one on each node -> default just one per cluster, on the head node)
- Add note about fault tolerance in different failure scenarios
- Assorted typos/usage nits

Co-authored-by: shrekris-anyscale <92341594+shrekris-anyscale@users.noreply.github.com>
Co-authored-by: Simon Mo <simon.mo@hey.com>
2022-08-03 14:30:33 -05:00
clarng
a2eaa7a5a4
[docs][Core] rename 'more topics' to 'advanced topics' (#27385)
Ray 2.0 doc update : Rename 'more topics' to 'advanced topics'. Also cleaned up misc topics to have a consistent name
2022-08-03 12:14:43 -07:00
Cade Daniel
99ad0667a5
[docs][Ray Clusters] Migrate Community Supported Cluster Launcher to new structure. (#27376)
This PR migrates the old Community Supported Cluster Launcher docs to the new Ray Clusters doc structure.

Signed-off-by: Cade Daniel <cade@anyscale.com>
2022-08-03 11:07:10 -07:00
xwjiang2010
ff2b728e9a
[air] add tuner user guide (#26837)
Co-authored-by: Kai Fricke <kai@anyscale.com>
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2022-08-03 09:43:42 -07:00
Archit Kulkarni
a12c04a2fe
[Serve] [Doc] Update key concepts for 2.0, remove deprecated APIs (#26965)
Removes deprecated APIs:
- serve.start()
- get_handle()

Rewrites the ServeHandle doc snippet to use the recommended workflow for ServeHandles (only access them from other deployments, pass Deployments in as input args to `.bind()`, which get resolved to ServeHandles at runtime)

Co-authored-by: shrekris-anyscale <92341594+shrekris-anyscale@users.noreply.github.com>
2022-08-03 11:27:23 -05:00
Jiajun Yao
8b7e4ac701
[Doc] Test ray core doc code (#27334)
- Currently not all code under ray-core/doc_code is covered by CI.
- tf_example.py and torch_example.py are not used anywhere.

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
2022-08-02 20:51:47 -07:00
Dmitri Gekhtman
4d87e8112a
[docs][kubernetes] GPU user guide (#27360)
Signed-off-by: Dmitri Gekhtman <dmitri.m.gekhtman@gmail.com>

This PR

adds a page of guidance on GPU deployment with Ray/K8s. This page is a modified and slightly expanded version of the existing page https://docs.ray.io/en/latest/cluster/kubernetes-gpu.html
moves managed K8s service intro links to their own page
2022-08-02 15:58:23 -07:00
Avnish Narayan
00f9438101
[RLlib] Training step docs. (#27344) 2022-08-02 23:41:45 +02:00
Archit Kulkarni
e02b072939
[Doc] [Serve] Edit grammar/usage/organization for HTTP adapters page (#26969)
Moves FastAPI into its own section instead of appearing in a duplicated note.

Co-authored-by: simon-mo <simon.mo@hey.com>
2022-08-02 15:08:05 -05:00
Richard Liaw
c8561071f3
[air/train/docs] gbdt trainer user guide (#27362)
Co-authored-by: Kai Fricke <kai@anyscale.com>
2022-08-02 13:02:42 -07:00
clarng
84674fa868
[docs] ray core namespace docs: edit pass & move python code into doc_code dir (#27341) 2022-08-02 12:52:30 -07:00
clarng
34385b8136
[docs] ray core cross-lang docs: edit pass & move python code into doc_code dir (#27350)
Edit pass. Move code into doc_code dir. Code in doc_code is verified by CI
2022-08-02 12:50:05 -07:00
Jiajun Yao
cd2e590567
Support placement_group=None in PlacementGroupSchedulingStrategy (#27370)
We decided to allow escaping the parent pg via `PlacementGroupSchedulingStrategy(placement_group=None)` instead of using "DEFAULT". Our doc is updated with that but in the code it's still not allowed.
2022-08-02 12:49:41 -07:00
Ricky Xu
82a24f9319
[Doc][Core][State Observability] Adding Python SDK doc and docstring (#26997)
1. Add doc for python SDK and docstrings on public SDK
2. Rename list -> ray_list and get -> ray_get for better naming 
3. Fix some typos 
4. Auto translate address to api server url.

Co-authored-by: SangBin Cho <rkooo567@gmail.com>
2022-08-02 11:24:59 -05:00
xwjiang2010
36cf1baa82
[air doc] checkpoint_freq --> checkpoint_frequency (#27325)
Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
2022-08-02 11:34:10 +01:00
Jules S. Damji
4045ba4841
[DOC Ray AIR] minor editorial tweaks for clarity and usage (#27128)
Co-authored-by: Jules Damji <jules@anyscale.com>
2022-08-01 21:09:04 -07:00
Dmitri Gekhtman
6efca71c35
[docs][kubernetes] XGBoost ML example (#27313)
Adds a guide on running an XGBoost-Ray workload using KubeRay.

Signed-off-by: Dmitri Gekhtman <dmitri.m.gekhtman@gmail.com>
2022-08-01 19:30:41 -07:00
shrekris-anyscale
324d8e4bca
[Serve] Serialize user_config with JSON instead of Pickle (#26235) 2022-08-01 17:53:43 -07:00
Eric Liang
f7ae8923f6
[docs] Reorganize the tensor data support docs; general editing (#26952)
Why are these changes needed?
Editing pass over the tensor support docs for clarity:

Make heavy use of tabbed guides to condense the content
Rewrite examples to be more organized around creating vs reading tensors
Use doc_code for testing
2022-08-01 17:31:41 -07:00
clarng
fffcae1cb4
[docs] ray core dag docs: edit pass & move code into separate dir (#27318) 2022-08-01 17:05:36 -07:00
shrekris-anyscale
cc84953da3
[Serve] [Docs] Update "Getting Started" documentation (#26745) 2022-08-01 16:31:48 -07:00
matthewdeng
fedfaddb3f
[docs] add k8s docs to toc (#27310) 2022-07-30 15:26:30 -07:00
clarng
a61478fb73
import style (#25755) 2022-07-30 09:43:09 -07:00
Dmitri Gekhtman
059895ab5b
[docs][kubernetes] Shift docs into new structure (#27239)
This PR shifts KubeRay docs into the structure introduced in #27036.
There are no content changes.
2022-07-29 14:19:51 -07:00
Siyuan (Ryans) Zhuang
1bcd3e41d1
[Workflow] Cleanup workflow docs (#27197)
* cleanup workflow docs

Signed-off-by: Siyuan Zhuang <suquark@gmail.com>
2022-07-29 13:03:50 -07:00
Kai Fricke
1f097e9d12
[tune/docs] Update custom syncer example (#27252)
There is a small bug in the docs example for custom command based syncers. This PR fixes them and adds a test to test these changes.

Signed-off-by: Kai Fricke <kai@anyscale.com>
2022-07-29 16:09:19 +01:00
xwjiang2010
d331489a9d
[ air ] clean up some more tune.run (#27117)
More replacements of tune.run() in examples/docstrings for Tuner.fit()

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

Co-authored-by: Kai Fricke <kai@anyscale.com>
2022-07-29 10:43:45 +01:00
Jimmy Yao
749d313dcd
hot fix ray lightning (#27235)
hot fix ray lightning #27235
2022-07-28 22:41:28 -07:00
Cade Daniel
0374637e53
Adding --keep-going flag to sphinx-build so all lint failures are listed in CI (#27068)
This PR adds --keep-going flag to the make html target for building the Ray docs. This means that when there is a lint failure in CI, the BuildKite log will show all lint failures instead of just the first one. Despite continuing past the first lint error, it will still fail the build.

Signed-off-by: Cade Daniel <cade@anyscale.com>
2022-07-28 16:24:27 -07:00