-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: Final doc changes for release 1.19
- Loading branch information
Showing
16 changed files
with
385 additions
and
445 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
.. _evolution: | ||
|
||
Evolution of randomgen | ||
====================== | ||
|
||
Changes in 1.19 | ||
--------------- | ||
|
||
:class:`~randomgen.generator.Generator` and :class:`~randomgen.mtrand.RandomState` have been | ||
officially deprecated, and will warn with a ``FutureWarning`` about their removal. They will | ||
also receive virtually no maintenance. It is now time to move to NumPy's :class:`numpy.random.Generator` | ||
which has features not in :class:`~randomgen.generator.Generator` and is maintained more actively. | ||
|
||
A few distributions that are not present in :class:`~randomgen.generator.Generator` have been moved | ||
to :class:`~randomgen.generator.ExtendedGenerator`: | ||
|
||
* :func:`~randomgen.generator.ExtendedGenerator.multivariate_normal`: which supports broadcasting | ||
* :func:`~randomgen.generator.ExtendedGenerator.uintegers`: fast 32 and 64-bit uniform integers | ||
* :func:`~randomgen.generator.ExtendedGenerator.complex_normal`: scalar complex normals | ||
|
||
There are no plans to remove any of the bit generators, e.g., :class:`~randomgen.aes.AESCounter`, | ||
:class:`~randomgen.threefry.ThreeFry`, or :class:`~randomgen.pcg64.PCG64`. | ||
|
||
Changes between 1.16 and 1.18 | ||
----------------------------- | ||
|
||
There are many changes between v1.16.x and v1.18.x. These reflect API | ||
decision taken in conjunction with NumPy in preparation of the core | ||
of ``randomgen`` being used as the preferred random number generator in | ||
NumPy. These all issue ``DeprecationWarning`` except for ``BitGenerator.generator`` | ||
which raises ``NotImplementedError``. The C-API has also changed to reflect | ||
the preferred naming the underlying Pseudo-RNGs, which are now known as | ||
bit generators (or ``BitGenerator``). | ||
|
||
The main changes are | ||
|
||
* Rename ``RandomGenerator`` to :class:`~randomgen.generator.Generator`. | ||
* Rename :meth:`~randomgen.generator.Generator.randint` to | ||
:meth:`~randomgen.generator.Generator.integers`. | ||
* Rename :meth:`~randomgen.generator.Generator.random_integers` to | ||
:meth:`~randomgen.generator.Generator.integers`. | ||
* Rename :meth:`~randomgen.generator.Generator.random_sample` to | ||
:meth:`~randomgen.generator.Generator.random`. | ||
* Change ``jump`` which operated in-place to ``jumped`` which returns a new ``BitGenerator``. | ||
* Rename Basic RNG to bit generator, which impacts the API in multiple places where names | ||
like ``brng`` and ``basic_rng`` have been replaced by ``bitgen`` or ``bit_generator``. | ||
* Support for :class:`~randomgen.seed_sequence.SeedSequences` (also support NumPy ``SeedSequence`` instances) | ||
* Removed support for Python 2.7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.