Update stanfit docstrings

Author: amas0

cmdstanpy/stanfit/gq.py

@@ -705,10 +705,7 @@ def _previous_draws_pd(
 
     def save_csvfiles(self, dir: str | None = None) -> None:
         """
-        Move output CSV files to specified directory.  If files were
-        written to the temporary session directory, clean filename.
-        E.g., save 'bernoulli-201912081451-1-5nm6as7u.csv' as
-        'bernoulli-201912081451-1.csv'.
+        Move output CSV files to specified directory.
 
         :param dir: directory path
 

cmdstanpy/stanfit/laplace.py

@@ -310,10 +310,7 @@ def column_names(self) -> tuple[str, ...]:
 
     def save_csvfiles(self, dir: str | None = None) -> None:
         """
-        Move output CSV files to specified directory.  If files were
-        written to the temporary session directory, clean filename.
-        E.g., save 'bernoulli-201912081451-1-5nm6as7u.csv' as
-        'bernoulli-201912081451-1.csv'.
+        Move output CSV files to specified directory.
 
         :param dir: directory path
 

cmdstanpy/stanfit/mcmc.py

@@ -824,10 +824,7 @@ def method_variables(self) -> dict[str, np.ndarray]:
 
     def save_csvfiles(self, dir: str | None = None) -> None:
         """
-        Move output CSV files to specified directory.  If files were
-        written to the temporary session directory, clean filename.
-        E.g., save 'bernoulli-201912081451-1-5nm6as7u.csv' as
-        'bernoulli-201912081451-1.csv'.
+        Move output CSV files to specified directory.
 
         :param dir: directory path
 

cmdstanpy/stanfit/mle.py

@@ -295,10 +295,7 @@ def stan_variables(
 
     def save_csvfiles(self, dir: str | None = None) -> None:
         """
-        Move output CSV files to specified directory.  If files were
-        written to the temporary session directory, clean filename.
-        E.g., save 'bernoulli-201912081451-1-5nm6as7u.csv' as
-        'bernoulli-201912081451-1.csv'.
+        Move output CSV files to specified directory.
 
         :param dir: directory path
 

cmdstanpy/stanfit/pathfinder.py

@@ -216,10 +216,7 @@ def is_resampled(self) -> bool:
 
     def save_csvfiles(self, dir: str | None = None) -> None:
         """
-        Move output CSV files to specified directory.  If files were
-        written to the temporary session directory, clean filename.
-        E.g., save 'bernoulli-201912081451-1-5nm6as7u.csv' as
-        'bernoulli-201912081451-1.csv'.
+        Move output CSV files to specified directory.
 
         :param dir: directory path
 

cmdstanpy/stanfit/vb.py

@@ -249,10 +249,7 @@ def variational_sample_pd(self) -> pd.DataFrame:
 
     def save_csvfiles(self, dir: str | None = None) -> None:
         """
-        Move output CSV files to specified directory.  If files were
-        written to the temporary session directory, clean filename.
-        E.g., save 'bernoulli-201912081451-1-5nm6as7u.csv' as
-        'bernoulli-201912081451-1.csv'.
+        Move output CSV files to specified directory.
 
         :param dir: directory path
 

cmdstanpy_tutorial.ipynb

@@ -98,6 +98,7 @@
     "CmdStanPy will use the following optional packages, if installed:\n",
     "\n",
     "* `xarray`, an n-dimension labeled dataset package which can be used for outputs\n",
+    "* `polars`, a highly-optimized data manipulation library, which can speed up processing outputs of large Stan models\n",
     "\n",
     "To install CmdStanPy with all the optional packages:\n",
     "\n",
@@ -408,7 +409,7 @@
    "hash": "d31ce8e45781476cfd394e192e0962028add96ff436d4fd4e560a347d206b9cb"
   },
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -422,9 +423,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.10.19"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }