Skip to content

Commit ea28a77

Browse files
committed
very early draft migration guide
1 parent 896da8d commit ea28a77

File tree

3 files changed

+6726
-1
lines changed

3 files changed

+6726
-1
lines changed

doc/source/api/preview.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
(preview_api)=
22

33
# Preview
4-
This module give access to upcoming refactored features by exposing
4+
5+
:::{py:module} arviz.preview
6+
This module gives access to upcoming refactored features by exposing
57
all objects in [arviz-base](https://arviz-base.readthedocs.io/en/latest/),
68
[arviz-stats](https://arviz-stats.readthedocs.io/en/latest/) and
79
[arviz-plots](https://arviz-plots.readthedocs.io/en/latest/)
810
under a single namespace: `arviz.preview`.
911

1012
In addition, there is also an `arviz.preview.info` to check availability
1113
of the different sub-libraries.
14+
:::
15+
16+
17+
:::{seealso}
18+
* Introduction to Exploratory Analysis of Bayesian Models and Bayesian workflow
19+
through [arviz.preview](https://arviz-devs.github.io/EABM/)
20+
* The {ref}`migration_guide` introduces the new arviz-xyz libraries through
21+
``arviz.preview`` focusing on the differences with current ArviZ,
22+
the reasons behind them and what new features can be unlocked through these changes.
23+
:::

doc/source/getting_started/Installation.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ functionality is available with the basic requirements, but ArviZ also has optio
77
dependencies to further enhance the library. This guide will cover both basic and fully-fledged ArviZ installs and several installation methods.
88

99

10+
.. tip::
11+
12+
If you are installing ArviZ for the first time, consider installing with
13+
14+
.. code:: bash
15+
16+
pip install "arviz[preview]"
17+
18+
And using the library through the {mod}`arviz.preview` module.
19+
There are still some features present in ``arviz.`` not available
20+
in ``arviz.preview.``, but most already are and there are also
21+
some new ones that are not available in ``arviz.`` (and won't ever be).
22+
23+
1024
******
1125
Stable
1226
******

0 commit comments

Comments
 (0)