Skip to content

Commit

Permalink
[doc] Minor typo fix.
Browse files Browse the repository at this point in the history
  • Loading branch information
SepandKashani committed Aug 21, 2024
1 parent 91434c7 commit aeda0c1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/migration_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Migrating from v1 to v2
=======================

With the release of `Pyxu v2`, several major improvements and changes have been introduced. This guide will help you smoothly transition your code from `v1`` to `v2`.
With the release of `Pyxu v2`, several major improvements and changes have been introduced. This guide will help you smoothly transition your code from `v1` to `v2`.

The most significant change is that `Pyxu v2` no longer vectorizes **N-dimensional** signals. In `v1`, vectorizing **N-dimensional** arrays caused Dask arrays to rechunk into 1-dimensional chunks, which required computing the array in a single node, thus breaking the distributed nature of Dask. In `v2`, the arrays remain **N-dimensional** throughout, and Dask arrays are not "computed" at any point, preserving the benefits of distributed computing.

Expand Down Expand Up @@ -84,7 +84,7 @@ Below is an example showing how to convert code from `v1` to `v2`.
**v2 Code**:

.. code-block:: python
# Applying the blurring and adding noise
conv = Convolve(
dim_shape=dim_shape, # v2: `dim_shape` replaces `arg_shape`
Expand Down Expand Up @@ -113,7 +113,7 @@ Below is an example showing how to convert code from `v1` to `v2`.
positivity = PositiveOrthant(dim_shape=dim_shape) # v2: `dim_shape` replaces `dim`
solver = PD3O(f=loss, g=positivity, h=l21, K=grad)
solver.fit(x0=y, stop_crit=stop_crit) # No flattening required in v2
Migration Tips
--------------
Expand All @@ -125,4 +125,4 @@ Migration Tips

Further Help
------------
If you encounter any issues during your migration, please consult the `API Reference` and `Example Gallery` or reach out to the community via our support channels.
If you encounter any issues during your migration, please consult the `API Reference` and `Example Gallery` or reach out to the community via our support channels.

0 comments on commit aeda0c1

Please sign in to comment.