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][tune] remove low value tune examples and references to them #41348

Merged
merged 8 commits into from
Nov 27, 2023

Conversation

angelinalg
Copy link
Contributor

@angelinalg angelinalg commented Nov 22, 2023

These examples are out of date or provide low value. Pruning body of examples to improve discovery of high value examples.
cc: @pcmoritz @richardliaw @matthewdeng

Checks

  • [sx] 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 :(

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg angelinalg added tune Tune-related issues docs An issue or change related to documentation labels Nov 22, 2023
Copy link
Contributor

@pcmoritz pcmoritz left a comment

Choose a reason for hiding this comment

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

Nice, this is great 🥳

@pcmoritz
Copy link
Contributor

@matthewdeng Can you make a follow up PR that removes the dragonfly-opt package from the dependencies (and any extra code / tests we have)?

@angelinalg angelinalg changed the title [docs][tune] remove dragonfly example [docs][tune] remove low value tune examples and references to them Nov 22, 2023
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@matthewdeng
Copy link
Contributor

@pcmoritz sure thing, can I get your thoughts on what the deprecation policy should be for these types of removals?

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@pcmoritz
Copy link
Contributor

For things like dragonfly which are not even really maintained upstream any more https://github.com/dragonfly/dragonfly (last substantial development was in 2020), we can just remove it without any deprecation.

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@pcmoritz
Copy link
Contributor

In general, if there is very low usage, very low doc views and/or the project seems abandoned, let's just remove it without deprecation. If you are unsure just use your best judgement :)

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@pcmoritz pcmoritz merged commit d432bd6 into ray-project:master Nov 27, 2023
13 of 16 checks passed
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 tune Tune-related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants