Add more badges to readme #424
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
romovpa
approved these changes
May 4, 2022
README.md
Outdated
Comment on lines
6
to
7
| [](https://github.com/pytorch/opacus/blob/main/CONTRIBUTING.md) | ||
| [](https://github.com/pytorch/opacus/blob/main/LICENSE) |
There was a problem hiding this comment.
I'm not sure it's a good idea, but we may consider using relative links here. In this case, the link will always points to the same branch and the same repository if someone clones.
|
@ashkan-software has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
7 tasks
facebook-github-bot
pushed a commit
that referenced
this pull request
Sep 29, 2022
Summary: ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Docs change / refactoring / dependency upgrade (None of the above - changes are made to CI pipeline) ## Motivation and Context / Related issue The objective was to have code coverage made [publicly accessible](#424) via https://coveralls.io To achieve this, the following changes were made: 1. move existing tests running via `pytest` & `unittest` to run via [`coverage`](https://coverage.readthedocs.io) 2. add dependency of `coverage` in `dev_requirements.txt`, followed by `coveralls` in CircleCI config 3. minor refactoring of tasks to prepare for upload to `coveralls` 4. upload coverage reports generated in `parallel` to `coveralls` as CircleCI tasks 5. at the end of workflow, signal `coveralls` to combine all `parallel` uploads under single run ## How Has This Been Tested (if it applies) Testing changes made to CircleCI config is tricky. Most of the code was tested via opening this PR and letting CircleCI run on this new config. Some obscure parts were tested in a personal CircleCI environment. ## Checklist - [ ] The documentation is up-to-date with the changes I made. - [x] I have read the **CONTRIBUTING** document and completed the CLA (see **CONTRIBUTING**). - [x] All tests passed, and additional code has been covered with new tests. Pull Request resolved: #515 Reviewed By: ashkan-software Differential Revision: D39795415 Pulled By: ashkan-software fbshipit-source-id: 82830bfea917bed7efcb15d854f7e1af34802dbb
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Types of changes
Motivation and Context / Related issue
Resolves #382
Also, if needed, I can add coveralls here to show the coverage of our tests: https://coveralls.io. I would need to create an account and connect the github repository PyTorch first, then enable it for Opacus
How Has This Been Tested (if it applies)
I tested this on my forked version and the badges appear correctly
Checklist