Commit graph

21 commits

Author SHA1 Message Date
Philipp Moritz
886cc4d674
Fix broken links in documentation and put linkcheck linter in place on CI (#23340) 2022-03-18 21:02:52 -07:00
Archit Kulkarni
76bb5396c7
[Doc] [jobs] Add links to Job Submission and improve doc (#23209)
- Adds links to Job Submission from existing library tutorials where `ray submit` is used.  When Jobs becomes GA, we should fully replace the uses of `ray submit` with Ray job submission and ensure this is tested.
- Adds docstrings for the Jobs SDK, which automatically show up in the API reference
- Improve the Job Submission main page
- Add a "Deployment Guide" landing page explaining when to use Ray Client vs Ray Jobs

Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2022-03-18 12:52:13 -05:00
Max Pumperla
7953c9ca57
[docs] integrate algolia docsearch, move to sphinx panels (#21814) 2022-01-24 17:00:41 -08:00
xwjiang2010
9af8f11191
Revert "[docs] Clean up doc structure (first part) (#21667)" (#21763)
This reverts commit 38e46c9fb3.
2022-01-20 15:30:56 -08:00
Max Pumperla
38e46c9fb3
[docs] Clean up doc structure (first part) (#21667) 2022-01-20 16:19:04 +01:00
Richard Liaw
169e422937
[docs] Make Jobs more prominent in documentation (#21575) 2022-01-13 23:49:34 -08:00
Ameer Haj Ali
e3e9697bea
[docs] autoscaler/K8s hiring roles (#20621)
* we are hiring

* fixes as philipp requested
2021-11-23 14:56:22 -08:00
javi-redondo
11371768c1
Update Ray client docs with working_dir explanation (#18294) 2021-11-04 14:52:28 -07:00
architkulkarni
fdefd875c3
[Doc] [runtime env] Move runtime env section up one level, add inbound links (#19863) 2021-10-29 12:02:39 -05:00
mwtian
d656b3a6d7
[Doc] Update instruction on starting Ray cluster for Ray client (#19653) 2021-10-22 19:14:07 -07:00
Ameer Haj Ali
923adb6512
Update docs to make sure user does ssh port forwarding from another terminal (#19367) 2021-10-21 13:17:08 -07:00
matthewdeng
83a28cc901
[client] update documentation with AWS security_group (#18905)
* [client] update documentation with AWS security_group

* Update doc/source/cluster/ray-client.rst

Co-authored-by: Ian Rodney <ian.rodney@gmail.com>

* lint

Co-authored-by: Ian Rodney <ian.rodney@gmail.com>
2021-09-28 16:47:46 -07:00
Yi Cheng
994d156a0d
[doc] Mark multi-client as an experimental feature 2021-09-27 14:08:49 -07:00
Yi Cheng
65fa740c3b
Fix minor doc error (#18896) 2021-09-24 22:21:10 -07:00
Yi Cheng
3d9c973861
[doc] Update ray client documentation to include multi-client. (#18891) 2021-09-24 18:35:52 -07:00
Antoni Baum
4c95ea6d0a
[client] Improve Ray Client connection timeout information (#18281)
* Improve Ray Client connection timeout information

* fix lint issue.

Co-authored-by: Ameer Haj Ali <ameerh@berkeley.edu>
2021-09-02 16:34:11 +03:00
77loopin
c6b24fcb5d
[RayClient] Add the guide for k8s Ingress (#17736)
Co-authored-by: Dmitri Gekhtman <62982571+DmitriGekhtman@users.noreply.github.com>
Co-authored-by: seungjaebaek <seungjaebaek@linecorp.com>
2021-08-20 18:31:03 -07:00
Chris K. W
a33cbec12a
[client][docs] update docs for new client support in init (#17333)
* start

* check formatting

* undo changes from base branch

* Client builder API docs

* indent

* 8

* minor fixes

* absolute path to runtime env docs

* fix runtime_env link

* Update worker.init docs

* drop clientbuilder docs, link to 1.4.1 docs instead. Specify local:// behavior when address passed

* add debug info for ray.init("local")

* local:// attaches a driver directly

* update ray.init return wording

* remote init.connect() from example

* drop local:// docs, add section on when to use ray client

* link to 1.4.1 docs in code example instead of mentioning clientbuilder

* fix backticks, doc mentions of ray.util.connect

* remove ray.util.connect mentions from examples and comments

* update tune example

* wording

* localhost:<port> also works if you're on the head node

* add quotes

* drop mentions of ray client from ray.init docstring

* local->remote

* fix section ref

* update ray start output

* fix section link

* try to fix doc again

* fix link wording

* drop local:// from docs and special handling from code

* update ray start message

* lint

* doc lint

* remove local:// codepath

* remove 'internal_config'

* Update doc/source/cluster/ray-client.rst

Co-authored-by: Ameer Haj Ali <ameerh@berkeley.edu>

* doc suggestion

* Update doc/source/cluster/ray-client.rst

Co-authored-by: Ameer Haj Ali <ameerh@berkeley.edu>
2021-08-04 05:31:44 +03:00
architkulkarni
756a4e7a90
[Core] [runtime env] update tests to use ray.init(runtime_env=...) and add e2e test (#17232) 2021-07-26 11:21:30 -05:00
Chris K. W
bd9d7bbbaa
[client] Add support for protocol (ray://, local://, custom://) to ray.init (#16946) 2021-07-14 21:45:46 -07:00
Ian Rodney
16d762aed0
[DocSprint] Ray Client Docs (#16497)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2021-06-19 10:05:37 -07:00