You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Welcome to `pymc-experimental`
2
2
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.
7
7
8
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.
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.
10
10
11
11
`pymc-experimental` would be designed to mirror the namespaces in `pymc` to make usage and migration as easy as possible.
12
12
For example, a `ParabolicFractal` distribution could be used analogously to those in `pymc`:
@@ -27,21 +27,21 @@ with pm.Model():
27
27
28
28
### What belongs in `pymc-experimental`?
29
29
30
-
- newly-implemented statistical methods, for example diagnostics or step methods
30
+
- newly-implemented statistical methods, for example step methods or model construction helpers
31
31
- distributions that are tricky to sample from or test
32
32
- infrequently-used fitting methods or distributions
33
33
- any code that requires additional optimization before it can be used in practice
34
34
35
35
36
36
### What does not belong in `pymc-experimental`?
37
37
- 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
39
39
40
40
41
41
### Should there be more than one add-on repository?
42
42
43
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.
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.
0 commit comments