add series sphinx docs entry and mark unstable

pola-rs · May 19, 2024 · a68782a · a68782a
1 parent 1e41760
commit a68782a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/crates/polars-core/src/chunked_array/ops/aggregate/mod.rs b/crates/polars-core/src/chunked_array/ops/aggregate/mod.rs
@@ -195,7 +195,7 @@ where
     }
 }
 
-/// Booleans are casted to 1 or 0.
+/// Booleans are cast to 1 or 0.
 impl BooleanChunked {
     pub fn sum(&self) -> Option<IdxSize> {
         Some(if self.is_empty() {

diff --git a/py-polars/docs/source/reference/series/export.rst b/py-polars/docs/source/reference/series/export.rst
@@ -10,7 +10,9 @@ Export Series data to other formats:
 
    Series.to_arrow
    Series.to_frame
+   Series.to_jax
    Series.to_list
    Series.to_numpy
    Series.to_pandas
    Series.to_init_repr
+   Series.to_torch
diff --git a/py-polars/polars/series/series.py b/py-polars/polars/series/series.py
@@ -4476,10 +4476,17 @@ def to_numpy(
 
         return self._s.to_numpy(allow_copy=allow_copy, writable=writable)
 
+    @unstable()
     def to_jax(self, device: jax.Device | str | None = None) -> jax.Array:
         """
         Convert this Series to a Jax Array.
 
+        .. versionadded:: 0.20.27
+
+        .. warning::
+            This functionality is currently considered **unstable**. It may be
+            changed at any point without it being considered a breaking change.
+
         Parameters
         ----------
         device
@@ -4519,10 +4526,17 @@ def to_jax(self, device: jax.Device | str | None = None) -> jax.Array:
                 order="K",
             )
 
+    @unstable()
     def to_torch(self) -> torch.Tensor:
         """
         Convert this Series to a PyTorch Tensor.
 
+        .. versionadded:: 0.20.23
+
+        .. warning::
+            This functionality is currently considered **unstable**. It may be
+            changed at any point without it being considered a breaking change.
+
         Examples
         --------
         >>> s = pl.Series("x", [1, 0, 1, 2, 0], dtype=pl.UInt8)