Skip to content

Commit 2a2e43d

Browse files
basnijholtbasnijholt
committed
Add doc-strings to load_dataframe
1 parent 68055fe commit 2a2e43d

File tree

6 files changed

+124
-0
lines changed

6 files changed

+124
-0
lines changed

‎adaptive/learner/average_learner.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,26 @@ def load_dataframe(
128128
seed_name: str = "seed",
129129
y_name: str = "y",
130130
):
131+
"""Load data from a `pandas.DataFrame`.
132+
133+
If ``with_default_function_args`` is True, then ``learner.function``'s
134+
default arguments are set (using `functools.partial`) from the values
135+
in the `pandas.DataFrame`.
136+
137+
Parameters
138+
----------
139+
df : pandas.DataFrame
140+
The data to load.
141+
with_default_function_args : bool, optional
142+
The ``with_default_function_args`` used in ``to_dataframe()``,
143+
by default True
144+
function_prefix : str, optional
145+
The ``function_prefix`` used in ``to_dataframe``, by default "function."
146+
seed_name : str, optional
147+
The ``seed_name`` used in ``to_dataframe``, by default "seed"
148+
y_name : str, optional
149+
The ``y_name`` used in ``to_dataframe``, by default "y"
150+
"""
131151
self.tell_many(df[seed_name].values, df[y_name].values)
132152
if with_default_function_args:
133153
self.function = partial_function_from_dataframe(

‎adaptive/learner/average_learner1D.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,28 @@ def load_dataframe(
209209
x_name: str = "x",
210210
y_name: str = "y",
211211
):
212+
"""Load data from a `pandas.DataFrame`.
213+
214+
If ``with_default_function_args`` is True, then ``learner.function``'s
215+
default arguments are set (using `functools.partial`) from the values
216+
in the `pandas.DataFrame`.
217+
218+
Parameters
219+
----------
220+
df : pandas.DataFrame
221+
The data to load.
222+
with_default_function_args : bool, optional
223+
The ``with_default_function_args`` used in ``to_dataframe()``,
224+
by default True
225+
function_prefix : str, optional
226+
The ``function_prefix`` used in ``to_dataframe``, by default "function."
227+
seed_name : str, optional
228+
The ``seed_name`` used in ``to_dataframe``, by default "seed"
229+
x_name : str, optional
230+
The ``x_name`` used in ``to_dataframe``, by default "x"
231+
y_name : str, optional
232+
The ``y_name`` used in ``to_dataframe``, by default "y"
233+
"""
212234
# Were using zip instead of df[[seed_name, x_name]].values because that will
213235
# make the seeds into floats
214236
seed_x = list(zip(df[seed_name].values.tolist(), df[x_name].values.tolist()))

‎adaptive/learner/learner1D.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,26 @@ def load_dataframe(
381381
x_name: str = "x",
382382
y_name: str = "y",
383383
):
384+
"""Load data from a `pandas.DataFrame`.
385+
386+
If ``with_default_function_args`` is True, then ``learner.function``'s
387+
default arguments are set (using `functools.partial`) from the values
388+
in the `pandas.DataFrame`.
389+
390+
Parameters
391+
----------
392+
df : pandas.DataFrame
393+
The data to load.
394+
with_default_function_args : bool, optional
395+
The ``with_default_function_args`` used in ``to_dataframe()``,
396+
by default True
397+
function_prefix : str, optional
398+
The ``function_prefix`` used in ``to_dataframe``, by default "function."
399+
x_name : str, optional
400+
The ``x_name`` used in ``to_dataframe``, by default "x"
401+
y_name : str, optional
402+
The ``y_name`` used in ``to_dataframe``, by default "y"
403+
"""
384404
self.tell_many(df[x_name].values, df[y_name].values)
385405
if with_default_function_args:
386406
self.function = partial_function_from_dataframe(

‎adaptive/learner/learner2D.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,28 @@ def load_dataframe(
452452
y_name: str = "y",
453453
z_name: str = "z",
454454
):
455+
"""Load data from a `pandas.DataFrame`.
456+
457+
If ``with_default_function_args`` is True, then ``learner.function``'s
458+
default arguments are set (using `functools.partial`) from the values
459+
in the `pandas.DataFrame`.
460+
461+
Parameters
462+
----------
463+
df : pandas.DataFrame
464+
The data to load.
465+
with_default_function_args : bool, optional
466+
The ``with_default_function_args`` used in ``to_dataframe()``,
467+
by default True
468+
function_prefix : str, optional
469+
The ``function_prefix`` used in ``to_dataframe``, by default "function."
470+
x_name : str, optional
471+
The ``x_name`` used in ``to_dataframe``, by default "x"
472+
y_name : str, optional
473+
The ``y_name`` used in ``to_dataframe``, by default "y"
474+
z_name : str, optional
475+
The ``z_name`` used in ``to_dataframe``, by default "z"
476+
"""
455477
self.tell_many(df[[x_name, y_name]].values, df[z_name].values)
456478
if with_default_function_args:
457479
self.function = partial_function_from_dataframe(

‎adaptive/learner/learnerND.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,26 @@ def load_dataframe(
456456
point_names: tuple[str, ...] = ("x", "y", "z"),
457457
value_name: str = "value",
458458
):
459+
"""Load data from a `pandas.DataFrame`.
460+
461+
If ``with_default_function_args`` is True, then ``learner.function``'s
462+
default arguments are set (using `functools.partial`) from the values
463+
in the `pandas.DataFrame`.
464+
465+
Parameters
466+
----------
467+
df : pandas.DataFrame
468+
The data to load.
469+
with_default_function_args : bool, optional
470+
The ``with_default_function_args`` used in ``to_dataframe()``,
471+
by default True
472+
function_prefix : str, optional
473+
The ``function_prefix`` used in ``to_dataframe``, by default "function."
474+
point_names : str, optional
475+
The ``point_names`` used in ``to_dataframe``, by default ("x", "y", "z")
476+
value_name : str, optional
477+
The ``value_name`` used in ``to_dataframe``, by default "value"
478+
"""
459479
self.tell_many(df[list(point_names)].values, df[value_name].values)
460480
if with_default_function_args:
461481
self.function = partial_function_from_dataframe(

‎adaptive/learner/sequence_learner.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,26 @@ def load_dataframe(
185185
x_name: str = "x",
186186
y_name: str = "y",
187187
):
188+
"""Load data from a `pandas.DataFrame`.
189+
190+
If ``with_default_function_args`` is True, then ``learner.function``'s
191+
default arguments are set (using `functools.partial`) from the values
192+
in the `pandas.DataFrame`.
193+
194+
Parameters
195+
----------
196+
df : pandas.DataFrame
197+
The data to load.
198+
with_default_function_args : bool, optional
199+
The ``with_default_function_args`` used in ``to_dataframe()``,
200+
by default True
201+
function_prefix : str, optional
202+
The ``function_prefix`` used in ``to_dataframe``, by default "function."
203+
x_name : str, optional
204+
The ``x_name`` used in ``to_dataframe``, by default "x"
205+
y_name : str, optional
206+
The ``y_name`` used in ``to_dataframe``, by default "y"
207+
"""
188208
self.tell_many(df[[index_name, x_name]].values, df[y_name].values)
189209
if with_default_function_args:
190210
self.function = partial_function_from_dataframe(

0 commit comments

Comments
 (0)