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

added ensemble model to docs #22771

Merged
merged 11 commits into from
Mar 25, 2022
Merged

added ensemble model to docs #22771

merged 11 commits into from
Mar 25, 2022

Conversation

frosk1
Copy link
Contributor

@frosk1 frosk1 commented Mar 2, 2022

@edoakes

Why are these changes needed?

Added ensemble model examples to the Documentation. That was needed, due to a user request and there was no methodology outlining the creation of higher level ensemble models.

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 :(

@edoakes
Copy link
Contributor

edoakes commented Mar 3, 2022

JFYI: I'm going OOO, ping @simon-mo to merge when it's ready

python/ray/serve/examples/doc/snippet_model_ensemble.py Outdated Show resolved Hide resolved
doc/BUILD Outdated Show resolved Hide resolved
@jiaodong
Copy link
Member

jiaodong commented Mar 6, 2022

In addition there're some docs linter formatting error on this commit .. Here's a readme about how to locally run linter https://sourcegraph.com/github.com/ray-project/ray/-/blob/doc/README.md

There's the error https://buildkite.com/ray-project/ray-builders-pr/builds/25782#00c390e0-8af9-49f4-b8c4-e13d09482406 with edit suggestions on the error message. Not sure if you can access it directly, it's https://gist.github.com/jiaodong/6839b1deb6259a9ba882711b1a98ba31.

All other content looks great to me, thanks for contributing !

python/ray/serve/BUILD Outdated Show resolved Hide resolved
python/ray/serve/examples/doc/snippet_model_ensemble.py Outdated Show resolved Hide resolved
@edoakes edoakes added the @external-author-action-required Alternate tag for PRs where the author doesn't have labeling permission. label Mar 7, 2022
print(all_predictions)


# start local cluster and ray serve processes
Copy link
Contributor

Choose a reason for hiding this comment

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

@jiaodong I'd argue that this snippet is a bit too long to simply put it at once into a docs section.

Do you think it would make sense to split this up a little and include this in parts? This way those good comments in the snippet can be actual text in the docs.

Copy link
Member

Choose a reason for hiding this comment

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

I agree this helps with readability. Given this PR is contributed by community and Jan already made a number of commits following existing pattern I think it might make more sense I just clean them up together as a separate PR to reduce friction on our community end ? The snippet_model_ensemble is structured the same way as snippet_model_composition, we need to better format both.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, indeed it is actually a little long. Maybe you can manage to add it as an example notebook or something similar. I think for users it is quite important to get the complete example as well.

@jiaodong
Copy link
Member

jiaodong commented Mar 8, 2022

@frosk1 can you rebase on master to resolve the merge conflict ? In addition the latest linter error is https://gist.github.com/jiaodong/b6a8b7b04facaf1ea68259b58253d78f that it starts to think differently about formatting after we shorten the data=input_data 🤦

@jiaodong
Copy link
Member

@frosk1 maybe you want to try git merge master directly ? Seems like we're unintentionally including all commits here ..

@frosk1
Copy link
Contributor Author

frosk1 commented Mar 10, 2022

@jiaodong I was thinking that simply rebasing was not a good plan, since it would include all other commits. I could have used merge --squash. But now I have reverted the rebase and merged it into current master. Please accept now or merge it yourself later, since I am not aware of the release cycle or merge times for master :)

@jiaodong
Copy link
Member

thanks @frosk1 ! We have conflicting new tests in the BUILD file but the content and test lgtm. We can take it from here and I will push commits to this PR to deal with conflicts.

@frosk1
Copy link
Contributor Author

frosk1 commented Mar 18, 2022

@jiaodong do you plan on merging these in the near future? :)

@jiaodong
Copy link
Member

@frosk1 yes we are :) sorry in last two weeks we're in full sprinting mode to push PRs for upcoming branch cut so I didn't follow up on this yet, but next week should be ok again

@jiaodong jiaodong added @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. and removed @external-author-action-required Alternate tag for PRs where the author doesn't have labeling permission. labels Mar 24, 2022
if __name__ == "__main__":
# start local cluster and ray serve processes
# Start ray with 8 processes.
if ray.is_initialized:
Copy link
Contributor

Choose a reason for hiding this comment

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

Just saw this -- it should be ray.is_initialized() I think :)

Copy link
Member

Choose a reason for hiding this comment

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

gooood catch

Copy link
Contributor

@edoakes edoakes left a comment

Choose a reason for hiding this comment

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

@jiaodong let's obviously remember to update this w/ first-class multi-model API when ready :)

@edoakes edoakes merged commit f78404d into ray-project:master Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants