KEMBAR78
[BE] Remove more optim entries from docs coverage ignore list by janeyx99 · Pull Request #160194 · pytorch/pytorch · GitHub
Skip to content

[BE] Remove more optim entries from docs coverage ignore list #160194

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

[BE] Remove more optim entries from docs coverage ignore list #160194

wants to merge 2 commits into from

Conversation

@janeyx99
Copy link
Contributor

@janeyx99 janeyx99 commented Aug 8, 2025 •
edited by pytorchmergebot
Loading

This PR does privatize ReduceLRSchedulerOnPlateau.is_better -> ReduceLRSchedulerOnPlateau._is_better because that API was never meant to be public. A GitHub search for it also reveals that the API is not commonly used much. https://github.com/search?q=.is_better%28&type=code&p=2

If you do use this API and you rely on it for some reason, please file an issue. In the meantime, you can access it through _is_better(...).

Stack from ghstack (oldest at bottom):

@janeyx99 janeyx99 requested a review from albanD as a code owner August 8, 2025 15:39
@pytorch-bot
Copy link

pytorch-bot bot commented Aug 8, 2025 •
edited
Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/160194

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 5d73888 with merge base 86eb65f (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

janeyx99 added a commit that referenced this pull request Aug 8, 2025
@janeyx99
[BE] Remove more entries from docs coverage ignore list
9fe32b6 
ghstack-source-id: 52fd267
Pull Request resolved: #160194
@janeyx99 janeyx99 changed the title [BE] Remove more entries from docs coverage ignore list [BE] Remove more optim entries from docs coverage ignore list Aug 8, 2025
albanD
albanD approved these changes Aug 8, 2025
View reviewed changes
Copy link
Collaborator

@albanD albanD left a comment

Choose a reason for hiding this comment

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

Nice!

@janeyx99 janeyx99 added suppress-bc-linter Suppresses the failures of API backward-compatibility linter (Lint/bc_linter) ciflow/trunk Trigger trunk jobs on your pull request labels Aug 8, 2025
@janeyx99
Copy link
Contributor Author

janeyx99 commented Aug 8, 2025

@pytorchbot merge

Docs test passed

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@pytorchmergebot
Copy link
Collaborator

Merge failed

Reason: 1 mandatory check(s) failed. The first few are:

Dig deeper by viewing the failures on hud

Details for Dev Infra team Raised by workflow job

Failing merge rule: Core Maintainers

@janeyx99
Copy link
Contributor Author

janeyx99 commented Aug 8, 2025

@pytorchbot merge -r

@pytorchmergebot
Copy link
Collaborator

@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here

@janeyx99
Update
5d73888 
[ghstack-poisoned]
pytorchmergebot pushed a commit that referenced this pull request Aug 8, 2025
@janeyx99
[BE] Remove more entries from docs coverage ignore list
82f4bc0 
ghstack-source-id: 8b04daa
Pull Request resolved: #160194
@pytorchmergebot
Copy link
Collaborator

Successfully rebased gh/janeyx99/298/orig onto refs/remotes/origin/viable/strict, please pull locally before adding more changes (for example, via ghstack checkout https://github.com/pytorch/pytorch/pull/160194)

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@github-actions github-actions bot deleted the gh/janeyx99/298/head branch September 8, 2025 02:15
markc-614 pushed a commit to markc-614/pytorch that referenced this pull request Sep 17, 2025
@janeyx99 @markc-614
[BE] Remove more optim entries from docs coverage ignore list (pytorc…
c4e1668 
…h#160194)

This PR does privatize ReduceLRSchedulerOnPlateau.is_better -> ReduceLRSchedulerOnPlateau._is_better because that API was never meant to be public. A GitHub search for it also reveals that the API is not commonly used much. https://github.com/search?q=.is_better%28&type=code&p=2

If you do use this API and you rely on it for some reason, please file an issue. In the meantime, you can access it through `_is_better(...)`.

Pull Request resolved: pytorch#160194
Approved by: https://github.com/albanD, https://github.com/Skylion007
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Skylion007 Skylion007 Skylion007 approved these changes

@albanD albanD albanD approved these changes

@mikaylagawarecki mikaylagawarecki Awaiting requested review from mikaylagawarecki

@jbschlosser jbschlosser Awaiting requested review from jbschlosser

Assignees

No one assigned

Labels

ciflow/trunk Trigger trunk jobs on your pull request Merged release notes: optim suppress-bc-linter Suppresses the failures of API backward-compatibility linter (Lint/bc_linter)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@janeyx99 @pytorchmergebot @Skylion007 @albanD