Skip to content

Commit 95d4404

Browse files
committed
Renamed experimental to extras in README
1 parent 3ba8792 commit 95d4404

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
# Welcome to `pymc-experimental`
2-
<a href="https://gitpod.io/#https://github.com/pymc-devs/pymc-experimental">
1+
# Welcome to `pymc-extras`
2+
<a href="https://gitpod.io/#https://github.com/pymc-devs/pymc-extras">
33
<img
44
src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod"
55
alt="Contribute with Gitpod"
66
/>
77
</a>
88
<img
9-
src="https://codecov.io/gh/pymc-devs/pymc-experimental/branch/main/graph/badge.svg"
9+
src="https://codecov.io/gh/pymc-devs/pymc-extras/branch/main/graph/badge.svg"
1010
alt="Codecov Badge"
1111
/>
1212

1313
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.
1414
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.
15-
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.
15+
To reduce the burden on the main `pymc` repository, this `pymc-extras` repository can become the aggregator and testing ground for new additions to PyMC.
1616
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.
1717

18-
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.
18+
The `pymc-extras` 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.
1919
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.
2020

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

2424
```python
2525
import pymc as pm
26-
import pymc_experimental as pmx
26+
import pymc_extras as pmx
2727

2828
with pm.Model():
2929

@@ -35,23 +35,23 @@ with pm.Model():
3535

3636
## Questions
3737

38-
### What belongs in `pymc-experimental`?
38+
### What belongs in `pymc-extras`?
3939

4040
- newly-implemented statistical methods, for example step methods or model construction helpers
4141
- distributions that are tricky to sample from or test
4242
- infrequently-used fitting methods or distributions
4343
- any code that requires additional optimization before it can be used in practice
4444

4545

46-
### What does not belong in `pymc-experimental`?
46+
### What does not belong in `pymc-extras`?
4747
- Case studies
4848
- Implementations that cannot be applied generically, for example because they are tied to variables from a toy example
4949

5050

5151
### Should there be more than one add-on repository?
5252

5353
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?
54-
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.
54+
For example, `pymc-extras` 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.
5555

5656

5757
### Unanswered questions & ToDos

0 commit comments

Comments
 (0)