Commit graph

45 commits

Author SHA1 Message Date
architkulkarni
42085fd3d5
[runtime env] [Doc] Add concepts and basic workflows (#20222)
Address followup comments from https://github.com/ray-project/ray/pull/19863
- Add short "Concepts" section
- Add more section headings to break up the text
- Add "Workflow: Local Files" example
- Add "Workflow: Library development" example
2021-11-19 13:58:50 -08:00
Qing Wang
1172195571
[Java] Remove global named actor and global pg (#20135)
This PR removes global named actor and global PGs.

I believe these APIs are not used widely in OSS.
CPP part is not included in this PR.
@kfstorm @clay4444 @raulchen Please take a look if this change is reasonable.


IMPORTANT NOTE: This is a Java API change and will lead backward incompatibility in Java global named actor and global PG usage.

CPP part is not included in this PR.
INCLUDES:

 Remove setGlobalName() and getGlobalActor() APIs.
 Remove getGlobalPlacementGroup() and setGlobalPG
 Add getActor(name, namespace) API
 Add getPlacementGroup(name, namespace) API
 Update doc pages.
2021-11-15 16:28:53 +08:00
Jules S. Damji
e6343f0e69
Fixed a broken code snippet with a missing method (#20130)
Signed-off-by: Jules S.Damji <jules@anyscale.com>

Co-authored-by: Jules S.Damji <jules@anyscale.com>
2021-11-08 07:56:32 +09: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
Jiajun Yao
ffe7108eae
Fix cpp api doc (#18671) 2021-09-17 14:01:23 -07:00
qicosmos
15881acffd
[C++ Worker]Update cpp worker doc (#18537) 2021-09-15 14:11:17 +08:00
Guyang Song
5713a0be6c
[C++ API] add C++ API docs (#17743) 2021-08-12 22:40:09 +08:00
SangBin Cho
74c9fa0650
Update unclear named actor doc & namespace (#16903)
* Update the named actor documentation

* Update the doc

* Update doc/source/actors.rst

* Move note to the end of the block not the beginning

Co-authored-by: Alex Wu <itswu.alex@gmail.com>
2021-07-06 15:51:29 -07:00
Alex Wu
3e94114336
Namespaces (#15774) 2021-05-17 10:04:22 -07:00
SangBin Cho
0e07b5fa89
[Doc] Update actor resource information (#13909)
* in progress.

* Revert "in progress."

This reverts commit 21a91a47522797210bdc5db9477bd0b02ed9d926.

* done.

* done.
2021-02-08 10:23:57 -08:00
Haoyuan Ge
875ea3fe1d
[docs] Update actors.rst (#13873)
Add "ray.get" when calling the actor method.
2021-02-03 09:51:53 -08:00
Richard Liaw
b0ca70f628
[tune+core] tune lifecycle and starting ray guide (#10813) 2020-09-21 11:27:50 -07:00
Max Fitton
017737b82b
[Documentation] local_mode doc updates and actor / worker explanation from Slack (#10748)
* wip

* Update local mode docs in all locations

* Update doc/source/actors.rst

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

* Update doc/source/actors.rst

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

* Change duplicated text to links to a subtitle for local_mode

* change a reference to be explicit

* Apply suggestions from code review

Co-authored-by: Max Fitton <max@semprehealth.com>
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-09-14 13:19:38 -07:00
Simon Mo
9e8e34240f
[Doc] Add section for threaded actor (#10751) 2020-09-11 16:34:10 -07:00
Kai Yang
f03e91788a
Java doc: "Using Actors" page (#10438) 2020-09-05 23:28:03 +08:00
Richard Liaw
3f98a8bfcb
[docs] Fix warnings for sphinx 1.8 (#10476)
* fix-build-for-sphinx18

* jnilit
2020-09-01 13:37:35 -07:00
Eric Liang
2a204260a8
[api] Second round of 1.0 API changes: exceptions, num_return_vals (#10377) 2020-08-28 19:57:02 -07:00
Eric Liang
519354a39a
[api] Initial API deprecations for Ray 1.0 (#10325) 2020-08-28 15:03:50 -07:00
Edward Oakes
94a069e575
Fix docs - atexit is not called when you ray.kill() an actor (#10367) 2020-08-28 13:51:10 -05:00
Eric Liang
bd245a1c18
[api] Clean up and document Actor name / lifetime API (#10332) 2020-08-27 13:38:39 -07:00
yncxcw
32cd94b750
[Core] Do not convert gpu id to int (#9744)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-08-11 12:09:46 -07:00
Hao Chen
d49dadf891
Change Python's ObjectID to ObjectRef (#9353) 2020-07-10 17:49:04 +08:00
Simon Mo
c9c84c87f4
[Serve] Add Instructions for GPU (#8495) 2020-05-19 18:33:58 -07:00
Eric Liang
eabb801a40
less important (#8439) 2020-05-13 22:52:38 -07:00
Richard Liaw
be5235d982
[tune] Clarify Intro Tune Documentation (#8201) 2020-04-27 18:01:00 -07:00
Edward Oakes
93fe4b0b58
Change actor.__ray_kill__() to ray.kill(actor) (#7360) 2020-02-28 11:55:13 -06:00
Eric Liang
5df801605e
Add ray.util package and move libraries from experimental (#7100) 2020-02-18 13:43:19 -08:00
zhu-eric
65297e65f0 Experimental Actor Pool (#6055)
* mod_table

* Example fix for gallery

* lint

* nit

* nit

* fix

* gallery

* remove table for now

* training, object store, tune, actors, advanced

* start tf code

* first cut tf

* yapf

* pytorch

* add torch example

* torch

* parallel

* tune

* tuning

* reviewsready

* finetune

* fix

* move_code

* update conf

* compile

* init hyperparameter

* Start images

* overview

* extra

* fix

* works

* update-ps-example

* param_actor

* fix

* examples

* simple

* simplify_pong

* flake8 and run hyperopt

* add comments

* add comments

* add suggestion

* add suggestion

* suggestions

* add suggestion

* add suggestions

* fixed in wrong area

* last edit

* finish changes

* add line

* format

* reset

* tests and docs

* fix tests

* bazelify

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2019-12-26 14:35:10 -08:00
Edward Oakes
6b1a57542e
Add actor.__ray_kill__() to terminate actors immediately (#6523) 2019-12-23 23:12:57 -06:00
Eric Liang
0b0a16982a [doc] Use .options() (#6323)
* options doc

* add note

* hint shr
2019-12-01 17:24:00 -08:00
Richard Liaw
898652837c
[minor][docs] Remove example link (#5880) 2019-10-11 11:49:18 -07:00
Eric Liang
1455a19c85
Consolidate and clean up documentation (#5645) 2019-09-07 11:50:18 -07:00
Richard Liaw
411f30c125
[docs] Second push of changes (#5391) 2019-08-28 17:54:15 -07:00
Richard Liaw
a08ea09760 [docs] rewrite (#5175) 2019-08-05 23:33:14 -07:00
Yuhong Guo
c2349cf12d Remove local/global_scheduler from code and doc. (#4549) 2019-04-03 17:05:09 -07:00
Robert Nishihara
658c14282c Remove legacy Ray code. (#3121)
* Remove legacy Ray code.

* Fix cmake and simplify monitor.

* Fix linting

* Updates

* Fix

* Implement some methods.

* Remove more plasma manager references.

* Fix

* Linting

* Fix

* Fix

* Make sure class IDs are strings.

* Some path fixes

* Fix

* Path fixes and update arrow

* Fixes.

* linting

* Fixes

* Java fixes

* Some java fixes

* TaskLanguage -> Language

* Minor

* Fix python test and remove unused method signature.

* Fix java tests

* Fix jenkins tests

* Remove commented out code.
2018-10-26 13:36:58 -07:00
Stephanie Wang
fb4d991732
Add actor reconstruction limitations to documentation (#1452)
* Add limitations to actor fault tolerance

* rename heading
2018-01-23 13:40:50 -08:00
Robert Nishihara
477a40f76d Prohibit returning actor handles and also update actor documentation. (#1246)
* Prohibit returning actor handles and also update actor documentation.

* Clarify documentation.
2017-11-23 09:37:24 -08:00
Crystal
8fc7dc3ed4 Change Python examples in documentation to use 4 space indentation. (#736)
* Ray doc - changed python indentation to 4 spaces in documentation files actors.rst, api.rst, and example-*.rst

* Ray documentation - changed Python to 4 space indentation for files install-*.rst, installation-troubleshooting.rst, internals-overview.rst, serialization.rst, troubleshootin.rst, tutorial.rst, using-ray-*.rst
2017-07-16 22:19:33 -07:00
Crystal
4c94d6c3b9 Rewrote and reordered the examples in the Actor documentation for cla… (#635)
* Rewrote and reordered the examples in the Actor documentation for clarity. Also added an introduction to Gym

* Minor tweaks to actor documentation

* Small changes to wording.
2017-06-02 23:42:41 -07:00
Michael Whittaker
1985838a30 Fixed small typo in actors.rst. (#595) 2017-05-25 11:30:45 -07:00
Robert Nishihara
3f30f29987 Fix typos in actor documentation. (#578)
* Fix typos in actor documentation.

* Reset the gym environment in actor documentation.
2017-05-20 23:06:44 -07:00
Robert Nishihara
ec2534422b Remove register_class from API. (#550)
* Perform ray.register_class under the hood.

* Fix bug.

* Release worker lock when waiting for imports to arrive in get.

* Remove calls to register_class from examples and tests.

* Clear serialization state between tests.

* Fix bug and add test for multiple custom classes with same name.

* Fix failure test.

* Fix linting and cleanups to python code.

* Fixes to documentation.

* Implement recursion depth for recursively registering classes.

* Fix linting.

* Push warning to user if waiting for class for too long.

* Fix typos.

* Don't export FunctionToRun if pickling the function fails.

* Don't broadcast class definition when pickling class.
2017-05-16 18:38:52 -07:00
Robert Nishihara
9f91eb8c91 Change API for remote function declaration, actor instantiation, and actor method invocation. (#541)
* Direction substitution of @ray.remote -> @ray.task.

* Changes to make '@ray.task' work.

* Instantiate actors with Class.remote() instead of Class().

* Convert actor instantiation in tests and examples from Class() to Class.remote().

* Change actor method invocation from object.method() to object.method.remote().

* Update tests and examples to invoke actor methods with .remote().

* Fix bugs in jenkins tests.

* Fix example applications.

* Change @ray.task back to @ray.remote.

* Changes to make @ray.actor -> @ray.remote work.

* Direct substitution of @ray.actor -> @ray.remote.

* Fixes.

* Raise exception if @ray.actor decorator is used.

* Simplify ActorMethod class.
2017-05-14 00:01:20 -07:00
Robert Nishihara
95bf81aeb8 Add actor tutorial. (#335) 2017-03-04 23:06:02 -08:00