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

[Doc][namespaces][C++ worker]add document for c++ worker namespace and specifying namespace while creating/getting named actors #26498

Merged
merged 6 commits into from
Jul 20, 2022

Conversation

WangTaoTheTonic
Copy link
Contributor

@WangTaoTheTonic WangTaoTheTonic commented Jul 13, 2022

Why are these changes needed?

We've supported namespace in c++ worker in #26327. Here we add doc for usage and also reinforce the documents of Java and Python, like adding explanation of specifying namespace while creating named actors.

  • add doc for basic c++ worker namespace usage
  • add explanation for specifying namespace while creating named actors, in Python, Java and C++

Related issue number

Checks

  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@WangTaoTheTonic WangTaoTheTonic changed the title [Doc][C++ worker]add document for c++ worker namespace [WIP][Doc][C++ worker]add document for c++ worker namespace Jul 13, 2022
@WangTaoTheTonic WangTaoTheTonic changed the title [WIP][Doc][C++ worker]add document for c++ worker namespace [Doc][namespaces][C++ worker]add document for c++ worker namespace and specifying namespace while creating/getting named actors Jul 14, 2022
@WangTaoTheTonic
Copy link
Contributor Author

@edoakes @ericl @maxpumperla @pcmoritz @richardliaw @simon-mo
Hi, could you help to review this doc change? Thanks.

@jovany-wang jovany-wang added the docs An issue or change related to documentation label Jul 14, 2022
@jovany-wang
Copy link
Contributor

@WangTaoTheTonic You missed DCO.

Signed-off-by: WangTaoTheTonic <[email protected]>
Signed-off-by: WangTaoTheTonic <[email protected]>
@jovany-wang
Copy link
Contributor

@ericl @simon-mo This PR needs to be approved by doc code owners, please take a look, thanks.

@simon-mo
Copy link
Contributor

@scv119 please take a look; since this is related to Ray Core documentation

class Actor:
pass

ctx = ray.init("ray:https://localhost:10001")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10001 is the ray client port; i believe it's not recommended in python and not supported in Java and C++. this means the Java and CPP code will fail

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I didn't know it's not recommended in python. I'll change the Java and C++ part first.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed the address part in C++. For the python part I'd like to keep it consistent with other descriptions in same doc. What do you think? @simon-mo

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm for these part and consistency issue, @scv119 and @jjyao should be able to take a look and recommend the best course of action here as they are also thinking about refactoring the documentation here.

Signed-off-by: WangTaoTheTonic <[email protected]>
richardliaw