Skip to content

Commit ad34429

Browse files
Apply suggestions from code review
Co-authored-by: Osvaldo Martin <[email protected]>
1 parent 9cc0b9f commit ad34429

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Diff for: README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Welcome to `pymc-experimental`
22

3-
As PyMC continues to mature and expand its functionality to accomodate more domains of application, we increasingly see cutting-edge methodologies, highly specialized statistical distributions, and complex models appear.
4-
While this adds to the functinoality and relevance of the project, it can also introduce instability and impose a burden on testing and quality control.
5-
To reduce the burden on the main `pymc` repository, this `pymc-experimental` respository can become the aggregator & testing ground for new additions to PyMC.
6-
This may include unusual probability distribitions, advanced model fitting algorithms, or any code that may be inappropriate to include in the `pymc` repository, but may want to be made available to users.
3+
As PyMC continues to mature and expand its functionality to accommodate more domains of application, we increasingly see cutting-edge methodologies, highly specialized statistical distributions, and complex models appear.
4+
While this adds to the functionality and relevance of the project, it can also introduce instability and impose a burden on testing and quality control.
5+
To reduce the burden on the main `pymc` repository, this `pymc-experimental` repository can become the aggregator and testing ground for new additions to PyMC.
6+
This may include unusual probability distributions, advanced model fitting algorithms, innovative yet not fully tested methods or any code that may be inappropriate to include in the `pymc` repository, but may want to be made available to users.
77

88
The `pymc-experimental` repository can be understood as the first step in the PyMC development pipeline, where all novel code is introduced until it is obvious that it belongs in the main repository.
9-
We hope that this improves the stability and streamlines the testing overhead of the `pymc` respository.
9+
We hope that this organization improves the stability and streamlines the testing overhead of the `pymc` repository, while allowing users and developers to test and evaluate cutting-edge methods and not yet fully mature features.
1010

1111
`pymc-experimental` would be designed to mirror the namespaces in `pymc` to make usage and migration as easy as possible.
1212
For example, a `ParabolicFractal` distribution could be used analogously to those in `pymc`:
@@ -27,21 +27,21 @@ with pm.Model():
2727

2828
### What belongs in `pymc-experimental`?
2929

30-
- newly-implemented statistical methods, for example diagnostics or step methods
30+
- newly-implemented statistical methods, for example step methods or model construction helpers
3131
- distributions that are tricky to sample from or test
3232
- infrequently-used fitting methods or distributions
3333
- any code that requires additional optimization before it can be used in practice
3434

3535

3636
### What does not belong in `pymc-experimental`?
3737
- Case studies
38-
- Implementations that cannot be applied generically
38+
- Implementations that cannot be applied generically, for example because they are tied to variables from a toy example
3939

4040

4141
### Should there be more than one add-on repository?
4242

4343
Since there is a lot of code that we may not want in the main repository, does it make sense to have more than one additional repository?
44-
For exmaple, `pymc-experimental` may just include methods that are not fully developed, tested and trusted, while code that is known to work well and has adequate test coverage could reside in a `pymc-extras` (or similar) repository.
44+
For example, `pymc-experimental` may just include methods that are not fully developed, tested and trusted, while code that is known to work well and has adequate test coverage, but is still too specialized to become part of `pymc` could reside in a `pymc-extras` (or similar) repository.
4545

4646

4747
### Unanswered questions & ToDos

0 commit comments

Comments
 (0)