Skip to content

Commit 9cc0b9f

Browse files
Rephrase to reflect maturation of the project
1 parent 48f2e6e commit 9cc0b9f

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
# Proposal: `pymc-experimental` repository
1+
# 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. 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. To help address this, a `pymc-experimental` respository could act as a home for new additions to PyMC, which 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 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.
47

5-
If implemented thoughtfully, a `pymc-experimental` repository could act 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. This would improve the stability and streamline the testing overhead of the `pymc` respository.
8+
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.
610

7-
`pymc-experimental` would be designed to mirror the namespaces in `pymc` to make usage and migration as easy as possible. For example, a `ParabolicFractal` distribution could be used analogously to those in `pymc`:
11+
`pymc-experimental` would be designed to mirror the namespaces in `pymc` to make usage and migration as easy as possible.
12+
For example, a `ParabolicFractal` distribution could be used analogously to those in `pymc`:
813

914
```python
1015
import pymc as pm
@@ -22,22 +27,30 @@ with pm.Model():
2227

2328
### What belongs in `pymc-experimental`?
2429

25-
- newly-implemented statistical methodologies
30+
- newly-implemented statistical methods, for example diagnostics or step methods
2631
- distributions that are tricky to sample from or test
2732
- infrequently-used fitting methods or distributions
2833
- any code that requires additional optimization before it can be used in practice
2934

3035

3136
### What does not belong in `pymc-experimental`?
37+
- Case studies
38+
- Implementations that cannot be applied generically
3239

3340

34-
### Should `pymc-experimental` be a submodule?
41+
### Should there be more than one add-on repository?
3542

43+
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.
3645

37-
### Should there be more than one add-on repository?
3846

39-
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? 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.
47+
### Unanswered questions & ToDos
48+
This project is still young and many things have not been answered or implemented.
49+
Please get involved!
4050

51+
* What are guidlines for organizing submodules?
52+
* Proposal: No default imports of WIP/unstable submodules. By importing manually we can avoid breaking the package if a submodule breaks, for example because of an updated dependency.
53+
* How can we minimize the additional burden of additional project repositories?
54+
* ToDo: Setting up a basic CI pipeline
4155

42-
### How can we minimize the additional burden of additional project repositories?
4356

0 commit comments

Comments
 (0)