Skip to content

Fix the problem that ray.remote reference is not visible at a document.#7311

Merged
simon-mo merged 2 commits intoray-project:masterfrom
rkooo567:ray-remote-doc-issue-2
Feb 28, 2020
Merged

Fix the problem that ray.remote reference is not visible at a document.#7311
simon-mo merged 2 commits intoray-project:masterfrom
rkooo567:ray-remote-doc-issue-2

Conversation

@rkooo567
Copy link
Copy Markdown
Contributor

@rkooo567 rkooo567 commented Feb 25, 2020

Why are these changes needed?

ray.remote document is not visible at the latest document. It is because we use fake_ray.remote for doc generation.

Related issue number

Checks

@simon-mo
Copy link
Copy Markdown
Contributor

simon-mo commented Feb 25, 2020

can you revert the deletion of doc/_build/.gitkeep? you can just touch doc/_build/.gitkeep

simon-mo
simon-mo approved these changes Feb 25, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@simon-mo simon-mo left a comment

Choose a reason for hiding this comment

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

lgtm, let's check if the doc build successfully

@rkooo567
Copy link
Copy Markdown
Contributor Author

rkooo567 commented Feb 25, 2020

@simon-mo Btw, format.sh deleted /doc/_build/.gitkeep. I am wondering if it is okay? Can you confirm?

@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Feb 25, 2020

Can one of the admins verify this patch?

@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Feb 25, 2020

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/22365/
Test FAILed.

@rkooo567
Copy link
Copy Markdown
Contributor Author

rkooo567 commented Feb 25, 2020

Jenkins test this please.

@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Feb 25, 2020

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/22391/
Test FAILed.

@rkooo567
Copy link
Copy Markdown
Contributor Author

rkooo567 commented Feb 26, 2020

Jenkins test this please.

@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Feb 27, 2020

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/22459/
Test FAILed.

@simon-mo
Copy link
Copy Markdown
Contributor

simon-mo commented Feb 27, 2020

@rkooo567 don't worry about jenkins test, can you add .gitkeep back? once you have done that i'll merge it

@rkooo567
Copy link
Copy Markdown
Contributor Author

rkooo567 commented Feb 27, 2020

@simon-mo Please force merge once it is ready.

@fyrestone
Copy link
Copy Markdown
Contributor

fyrestone commented Feb 27, 2020

@ray.remote will be executed when sphinx generating doc. If a isinstance(x, cython type) exists in @ray.remote logic, sphinx will raise an exception because cython types are mocked as objects not types.

@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Feb 27, 2020

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/22478/
Test PASSed.

raulchen
raulchen approved these changes Feb 27, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@raulchen raulchen left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this.

@simon-mo simon-mo merged commit 50145e6 into ray-project:master Feb 28, 2020
@simon-mo
Copy link
Copy Markdown
Contributor

simon-mo commented Feb 28, 2020

@fyrestone the doc seems to be building with this PR (without the exception). Is there any way we can catch the instance(x, cython type) error? If so we you help us create a separate PR to fix the cython mocking?

ffbin pushed a commit to antgroup/ant-ray that referenced this pull request Mar 20, 2020
@rkooo567
Fix the problem that ray.remote reference is not visible at a documen…
87efd83 
…t. (ray-project#7311)
@rkooo567 rkooo567 deleted the ray-remote-doc-issue-2 branch February 17, 2022 00:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@raulchen raulchen raulchen approved these changes

@simon-mo simon-mo simon-mo approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@rkooo567 @simon-mo @AmplabJenkins @fyrestone @raulchen