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

[docs][cherry-pick] Example Gallery clean up #41750

Merged
merged 6 commits into from
Dec 21, 2023

Conversation

angelinalg
Copy link
Contributor

Cherry-picking for 2.9.0:

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • 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 added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • 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 :(

angelinalg and others added 5 commits December 8, 2023 12:50
…project#41472)

Removing outdated examples.
cc: @sven1977

Signed-off-by: angelinalg <[email protected]>

---------

Signed-off-by: angelinalg <[email protected]>
Co-authored-by: Sven Mika <[email protected]>
…nes on the Train Examples page (ray-project#41596)

The Example Gallery with the training tag selected generates more examples than is in the Train Examples page. Removing some mislabelled examples by removing the training tag. Adding in two missing examples:

templates/04_finetuning_llms_with_deepspeed/ (Fine-tuning Llama-2 models)
/train/examples/transformers/transformers_torch_trainer_basic

---------

Signed-off-by: angelinalg <[email protected]>
…roject#41682)

After much discussion, we are removing the concept and examples associated with MMT. We had three different ways of running it (Core, Data, Tune). We no longer recommend Tune. Although this is a valid workload, the upkeep of the examples and docs outweigh the value, based on page views. When there is more traction on this type of use case, we can create a more up-to-date example.
@pcmoritz @richardliaw @matthewdeng

Signed-off-by: angelinalg <[email protected]>
…ay-project#41686)

After much discussion, the Data Processing tag is too general. Removing it from the Example Gallery.
cc: @amogkam @scottjlee @pcmoritz

Signed-off-by: angelinalg <[email protected]>
Subsections are appearing in the Serve Examples page as separate docs vs sections of the Streaming doc.

Signed-off-by: angelinalg <[email protected]>
@angelinalg angelinalg changed the title Cp 2.9.0 [docs][cherry-pick] Example Gallery clean up Dec 8, 2023
@architkulkarni architkulkarni self-assigned this Dec 8, 2023
@zhe-thoughts
Copy link
Collaborator

Is it OK to pick this after we build the wheel? This is just me being over cautious about having the wheel on time

@architkulkarni
Copy link
Contributor

If all the changes were in doc I think it would be okay to merge after the final wheel build. But this PR has changes outside of doc, and it even looks like an RLlib unit test is modified. So it might be better to merge it before. (Assuming the unit test passes)

@architkulkarni architkulkarni added the release-blocker P0 Issue that blocks the release label Dec 8, 2023
@angelinalg
Copy link
Contributor Author

I believe the failing exploding-death-star tests were signed off by @sven1977 except for the exploding-death-star-rllib-contrib-qmix-tests. I presume this is also a flakey test. Could someone from RLlib confirm?

Copy link
Contributor

@sven1977 sven1977 left a comment

Choose a reason for hiding this comment

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

Approved from RLlib perspective.
Thanks for this PR @angelinalg !

Copy link
Collaborator

@zhe-thoughts zhe-thoughts left a comment

Choose a reason for hiding this comment

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

Approved, but @architkulkarni if possible let's pick after we are able to have a green wheel without this PR (that we can easily go back to)

@architkulkarni
Copy link
Contributor

Sounds good. Everything looks good, will merge after we have the first "green commit" on the release branch

@architkulkarni architkulkarni merged commit 932eed0 into ray-project:releases/2.9.0 Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation release-blocker P0 Issue that blocks the release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants