Skip to content

Commit

Permalink
Doc preparation for 0.10.0rc1 (#1129)
Browse files Browse the repository at this point in the history
* Doc preparation for 0.10.0rc1

* Update release notes

* Final touches
  • Loading branch information
ivirshup authored Sep 9, 2023
1 parent f3e9c32 commit 40a4878
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 32 deletions.
1 change: 1 addition & 0 deletions anndata/experimental/merge.py
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,7 @@ def concat_on_disk(
arrays use the max_loaded_elems argument; for dense arrays
see the Dask documentation, as the Dask concatenation function is used
to concatenate dense arrays in this function
Params
------
in_files
Expand Down
9 changes: 9 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,15 @@ Interface for accessing on-disk sparse data:
experimental.CSCDataset
```

Out of core concatenation

```{eval-rst}
.. autosummary::
:toctree: generated/
experimental.concat_on_disk
```

Low level methods for reading and writing elements of an `` AnnData` `` object to a store:

```{eval-rst}
Expand Down
12 changes: 7 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,13 @@
```{include} ../README.md
```

# News

```{include} news.md
```

# Latest additions

```{include} release-notes/release-latest.md
```

See {doc}`/release-notes/index` for more.

```{toctree}
:hidden: true
:maxdepth: 1
Expand All @@ -33,3 +30,8 @@ contributing
release-notes/index
references
```

# News

```{include} news.md
```
28 changes: 20 additions & 8 deletions docs/release-notes/0.10.0.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,36 @@
### 0.10.0 {small}`the future`
### 0.10.0rc1 {small}`2023-09-09`

````{note}
anndata 0.10.0 is currently available as a release candidate for testing. You can install this version of anndata with:
```
pip install -U --pre anndata
```
We expect to make a full release by October.
````

```{rubric} Features
```

**GPU Support**

* Support for dense and sparse cupy arrays {pr}`1066` {user}`ivirshup`
* Dense and sparse [`CuPy`](https://docs.cupy.dev/l) arrays are now supported {pr}`1066` {user}`ivirshup`
* Once you have `CuPy` arrays in your anndata, use it with: [`rapids-singlecell`](https://rapids-singlecell.readthedocs.io/en/latest/index.html) from v0.9+
* anndata now has GPU enabled CI. Made possibly by a grant from [CZI's EOSS program](https://chanzuckerberg.com/eoss/) and managed via [Cirun](https://Cirun.io) {pr}`1066` {pr}`1084` {user}`Zethson` {user}`ivirshup`

**Out of core**

* Concatenate on-disk anndata objects with {func}`anndata.experimental.concat_on_disk` {pr}`955` {user}`selmanozleyen`
* AnnData can now hold dask arrays with `scipy.sparse.spmatrix` chunks {pr}`1114` {user}`ivirshup`
* Public API for interacting with on disk sparse arrays: {func}`~anndata.experimental.sparse_dataset`, {class}`~anndata.experimental.CSRDataset`, and {class}`~anndata.experimental.CSCDataset` {pr}`765` {user}`ilan-gold` {user}`ivirshup`

**Improved errors and warnings**

* Improved error messages when combining dataframes with duplicated column names {pr}`1029` {user}`ivirshup`
* Improved warnings when modifying views of `AlingedMappings` {pr}`1016` {user}`flying-sheep` {user}`ivirshup`
* `AnnDataReadError`s have been removed. The original error is now thrown with additional information in a note {pr}`1055` {user}`ivirshup`

**Out of core**

* AnnData can now hold dask arrays with `scipy.sparse.spmatrix` chunks {pr}`1114` {user}`ivirshup`
* Export {func}`~anndata.experimental.sparse_dataset`, {class}`~anndata.experimental.CSRDataset`, and {class}`~anndata.experimental.CSCDataset` from `experimental` to allow for use with `zarr` stores {pr}`765` {user}`ilan-gold` {user}`ivirshup`


```{rubric} Documentation
```
Expand All @@ -32,7 +44,7 @@
```{rubric} Other updates
```

- Bump minimum python version to 3.9 {pr}`1117` {user}`flying-sheep`
* Bump minimum python version to 3.9 {pr}`1117` {user}`flying-sheep`

```{rubric} Deprecations
```
Expand Down
19 changes: 19 additions & 0 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,25 @@
```{include} /release-notes/release-latest.md
```

## Version 0.9

```{include} /release-notes/0.9.2.md
```

```{include} /release-notes/0.9.1.md
```

```{include} /release-notes/0.9.0.md
```

## Version 0.8

```{include} /release-notes/0.8.1.md
```

```{include} /release-notes/0.8.0.md
```

## Version 0.7

```{include} /release-notes/0.7.8.md
Expand Down
19 changes: 0 additions & 19 deletions docs/release-notes/release-latest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,3 @@

```{include} /release-notes/0.10.0.md
```

## Version 0.9

```{include} /release-notes/0.9.2.md
```

```{include} /release-notes/0.9.1.md
```

```{include} /release-notes/0.9.0.md
```

## Version 0.8

```{include} /release-notes/0.8.1.md
```

```{include} /release-notes/0.8.0.md
```

0 comments on commit 40a4878

Please sign in to comment.