tensorflow / tensorflow/probability
Default bijector documentation
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 4.4k
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
I struck lucky today: I wanted to know what the default_event_space_bijector() was for a Beta distribution, and when I looked up the doc for tfd.Beta.experimental_default_event_space_bijector() it told me. Then, I wanted to know what it was for a Gamma distribution, but found that the tfd.Gamma.experimental_default_event_space_bijector() documents the bijector for a Beta distribution, but not for a Gamma.
Is there any possibility to get the bijector class returned by tfd.Distribution.experimental_default_event_space_bijector() into the doc strings for distributions? With a badly behaving model, and for writing methods papers, it would be useful to be able to look this up without dragging through the TFP source or running a test script.
Thanks, as always!
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 at tfd.Distribution.experimental_default_event_space_bijector() and compare the existing documentation for tfd.Beta.experimental_default_event_space_bijector() with tfd.Gamma.experimental_default_event_space_bijector(). Determine how distribution docstrings expose the returned bijector class; done means the relevant distribution documentation identifies its default event-space bijector without requiring source inspection or a test script.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100