Add doc-strings to load_dataframe

Author: basnijholt

adaptive/learner/average_learner.py

@@ -128,6 +128,26 @@ def load_dataframe(
         seed_name: str = "seed",
         y_name: str = "y",
     ):
+        """Load data from a `pandas.DataFrame`.
+
+        If ``with_default_function_args`` is True, then ``learner.function``'s
+        default arguments are set (using `functools.partial`) from the values
+        in the `pandas.DataFrame`.
+
+        Parameters
+        ----------
+        df : pandas.DataFrame
+            The data to load.
+        with_default_function_args : bool, optional
+            The ``with_default_function_args`` used in ``to_dataframe()``,
+            by default True
+        function_prefix : str, optional
+            The ``function_prefix`` used in ``to_dataframe``, by default "function."
+        seed_name : str, optional
+            The ``seed_name`` used in ``to_dataframe``, by default "seed"
+        y_name : str, optional
+            The ``y_name`` used in ``to_dataframe``, by default "y"
+        """
         self.tell_many(df[seed_name].values, df[y_name].values)
         if with_default_function_args:
             self.function = partial_function_from_dataframe(

adaptive/learner/average_learner1D.py

@@ -209,6 +209,28 @@ def load_dataframe(
         x_name: str = "x",
         y_name: str = "y",
     ):
+        """Load data from a `pandas.DataFrame`.
+
+        If ``with_default_function_args`` is True, then ``learner.function``'s
+        default arguments are set (using `functools.partial`) from the values
+        in the `pandas.DataFrame`.
+
+        Parameters
+        ----------
+        df : pandas.DataFrame
+            The data to load.
+        with_default_function_args : bool, optional
+            The ``with_default_function_args`` used in ``to_dataframe()``,
+            by default True
+        function_prefix : str, optional
+            The ``function_prefix`` used in ``to_dataframe``, by default "function."
+        seed_name : str, optional
+            The ``seed_name`` used in ``to_dataframe``, by default "seed"
+        x_name : str, optional
+            The ``x_name`` used in ``to_dataframe``, by default "x"
+        y_name : str, optional
+            The ``y_name`` used in ``to_dataframe``, by default "y"
+        """
         # Were using zip instead of df[[seed_name, x_name]].values because that will
         # make the seeds into floats
         seed_x = list(zip(df[seed_name].values.tolist(), df[x_name].values.tolist()))

adaptive/learner/learner1D.py

@@ -381,6 +381,26 @@ def load_dataframe(
         x_name: str = "x",
         y_name: str = "y",
     ):
+        """Load data from a `pandas.DataFrame`.
+
+        If ``with_default_function_args`` is True, then ``learner.function``'s
+        default arguments are set (using `functools.partial`) from the values
+        in the `pandas.DataFrame`.
+
+        Parameters
+        ----------
+        df : pandas.DataFrame
+            The data to load.
+        with_default_function_args : bool, optional
+            The ``with_default_function_args`` used in ``to_dataframe()``,
+            by default True
+        function_prefix : str, optional
+            The ``function_prefix`` used in ``to_dataframe``, by default "function."
+        x_name : str, optional
+            The ``x_name`` used in ``to_dataframe``, by default "x"
+        y_name : str, optional
+            The ``y_name`` used in ``to_dataframe``, by default "y"
+        """
         self.tell_many(df[x_name].values, df[y_name].values)
         if with_default_function_args:
             self.function = partial_function_from_dataframe(

adaptive/learner/learner2D.py

@@ -452,6 +452,28 @@ def load_dataframe(
         y_name: str = "y",
         z_name: str = "z",
     ):
+        """Load data from a `pandas.DataFrame`.
+
+        If ``with_default_function_args`` is True, then ``learner.function``'s
+        default arguments are set (using `functools.partial`) from the values
+        in the `pandas.DataFrame`.
+
+        Parameters
+        ----------
+        df : pandas.DataFrame
+            The data to load.
+        with_default_function_args : bool, optional
+            The ``with_default_function_args`` used in ``to_dataframe()``,
+            by default True
+        function_prefix : str, optional
+            The ``function_prefix`` used in ``to_dataframe``, by default "function."
+        x_name : str, optional
+            The ``x_name`` used in ``to_dataframe``, by default "x"
+        y_name : str, optional
+            The ``y_name`` used in ``to_dataframe``, by default "y"
+        z_name : str, optional
+            The ``z_name`` used in ``to_dataframe``, by default "z"
+        """
         self.tell_many(df[[x_name, y_name]].values, df[z_name].values)
         if with_default_function_args:
             self.function = partial_function_from_dataframe(

adaptive/learner/learnerND.py

@@ -456,6 +456,26 @@ def load_dataframe(
         point_names: tuple[str, ...] = ("x", "y", "z"),
         value_name: str = "value",
     ):
+        """Load data from a `pandas.DataFrame`.
+
+        If ``with_default_function_args`` is True, then ``learner.function``'s
+        default arguments are set (using `functools.partial`) from the values
+        in the `pandas.DataFrame`.
+
+        Parameters
+        ----------
+        df : pandas.DataFrame
+            The data to load.
+        with_default_function_args : bool, optional
+            The ``with_default_function_args`` used in ``to_dataframe()``,
+            by default True
+        function_prefix : str, optional
+            The ``function_prefix`` used in ``to_dataframe``, by default "function."
+        point_names : str, optional
+            The ``point_names`` used in ``to_dataframe``, by default ("x", "y", "z")
+        value_name : str, optional
+            The ``value_name`` used in ``to_dataframe``, by default "value"
+        """
         self.tell_many(df[list(point_names)].values, df[value_name].values)
         if with_default_function_args:
             self.function = partial_function_from_dataframe(

adaptive/learner/sequence_learner.py

@@ -185,6 +185,26 @@ def load_dataframe(
         x_name: str = "x",
         y_name: str = "y",
     ):
+        """Load data from a `pandas.DataFrame`.
+
+        If ``with_default_function_args`` is True, then ``learner.function``'s
+        default arguments are set (using `functools.partial`) from the values
+        in the `pandas.DataFrame`.
+
+        Parameters
+        ----------
+        df : pandas.DataFrame
+            The data to load.
+        with_default_function_args : bool, optional
+            The ``with_default_function_args`` used in ``to_dataframe()``,
+            by default True
+        function_prefix : str, optional
+            The ``function_prefix`` used in ``to_dataframe``, by default "function."
+        x_name : str, optional
+            The ``x_name`` used in ``to_dataframe``, by default "x"
+        y_name : str, optional
+            The ``y_name`` used in ``to_dataframe``, by default "y"
+        """
         self.tell_many(df[[index_name, x_name]].values, df[y_name].values)
         if with_default_function_args:
             self.function = partial_function_from_dataframe(