tensorflow / tensorflow/probability
CONTRIBUTING doc unit test instructions are incomplete
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 4.4k
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
We now generate jax/numpy backend tests for every test target. Many of these don't pass yet (work in progress...) and are tagged with notap (ie, "don't run on TAP" -- Google's internal CI system). To run tests locally, users should include the --test_tag_filter=-notap flag to bazel. This is far from obvious. At minimum we should indicate this in the contributor docs. We could also provide a wrapper script that makes it easier to run tests with all the expected flags.
NB: the testing/run_tests.sh script is the current source of truth for how to run tests correctly (it's what Travis CI uses).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading testing/run_tests.sh, which the issue identifies as the source of truth, then locate the contributor documentation covering Bazel test commands. Update those instructions to include the -notap test tag filter and align them with the script; completion means a newcomer can run the intended local tests from the docs.】【。}સ 彩神争霸安卓? Wait JSON has weird period? String okay but trailing weird? We need ensure exact valid JSON. I accidentally included
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, tensorflow
- Domain
- build-system, documentation, testing
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100