Skip to content

Commit

Permalink
Fix ArchiveDataframe link in visualize docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
btjanaka committed Jan 23, 2024
1 parent 771a72b commit fed039e
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions ribs/visualize/_cvt_archive_3d_plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,10 +155,10 @@ def cvt_archive_3d_plot(
this argument instead of the data currently in the archive. This
data can be obtained by, for instance, calling
:meth:`ribs.archives.ArchiveBase.data` with ``return_type="pandas"``
and modifying the resulting :class:`ArchiveDataFrame`. Note that, at
a minimum, the data must contain columns for index, objective, and
measures. To display a custom metric, replace the "objective"
column.
and modifying the resulting
:class:`~ribs.archives.ArchiveDataFrame`. Note that, at a minimum,
the data must contain columns for index, objective, and measures. To
display a custom metric, replace the "objective" column.
measure_order (array-like of int): Specifies the axes order for plotting
the measures. By default, the first measure (measure 0) in the
archive appears on the x-axis, the second (measure 1) on y-axis, and
Expand Down
8 changes: 4 additions & 4 deletions ribs/visualize/_cvt_archive_heatmap.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ def cvt_archive_heatmap(archive,
this argument instead of the data currently in the archive. This
data can be obtained by, for instance, calling
:meth:`ribs.archives.ArchiveBase.data` with ``return_type="pandas"``
and modifying the resulting :class:`ArchiveDataFrame`. Note that, at
a minimum, the data must contain columns for index, objective, and
measures. To display a custom metric, replace the "objective"
column.
and modifying the resulting
:class:`~ribs.archives.ArchiveDataFrame`. Note that, at a minimum,
the data must contain columns for index, objective, and measures. To
display a custom metric, replace the "objective" column.
transpose_measures (bool): By default, the first measure in the archive
will appear along the x-axis, and the second will be along the
y-axis. To switch this behavior (i.e. to transpose the axes), set
Expand Down
8 changes: 4 additions & 4 deletions ribs/visualize/_grid_archive_heatmap.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ def grid_archive_heatmap(archive,
this argument instead of the data currently in the archive. This
data can be obtained by, for instance, calling
:meth:`ribs.archives.ArchiveBase.data` with ``return_type="pandas"``
and modifying the resulting :class:`ArchiveDataFrame`. Note that, at
a minimum, the data must contain columns for index, objective, and
measures. To display a custom metric, replace the "objective"
column.
and modifying the resulting
:class:`~ribs.archives.ArchiveDataFrame`. Note that, at a minimum,
the data must contain columns for index, objective, and measures. To
display a custom metric, replace the "objective" column.
transpose_measures (bool): By default, the first measure in the archive
will appear along the x-axis, and the second will be along the
y-axis. To switch this behavior (i.e. to transpose the axes), set
Expand Down
8 changes: 4 additions & 4 deletions ribs/visualize/_parallel_axes_plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ def parallel_axes_plot(archive,
this argument instead of the data currently in the archive. This
data can be obtained by, for instance, calling
:meth:`ribs.archives.ArchiveBase.data` with ``return_type="pandas"``
and modifying the resulting :class:`ArchiveDataFrame`. Note that, at
a minimum, the data must contain columns for index, objective, and
measures. To display a custom metric, replace the "objective"
column.
and modifying the resulting
:class:`~ribs.archives.ArchiveDataFrame`. Note that, at a minimum,
the data must contain columns for index, objective, and measures. To
display a custom metric, replace the "objective" column.
measure_order (list of int or list of (int, str)): If this is a list
of ints, it specifies the axes order for measures (e.g. ``[2, 0,
1]``). If this is a list of tuples, each tuple takes the form
Expand Down
8 changes: 4 additions & 4 deletions ribs/visualize/_sliding_boundaries_archive_heatmap.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ def sliding_boundaries_archive_heatmap(archive,
this argument instead of the data currently in the archive. This
data can be obtained by, for instance, calling
:meth:`ribs.archives.ArchiveBase.data` with ``return_type="pandas"``
and modifying the resulting :class:`ArchiveDataFrame`. Note that, at
a minimum, the data must contain columns for index, objective, and
measures. To display a custom metric, replace the "objective"
column.
and modifying the resulting
:class:`~ribs.archives.ArchiveDataFrame`. Note that, at a minimum,
the data must contain columns for index, objective, and measures. To
display a custom metric, replace the "objective" column.
transpose_measures (bool): By default, the first measure in the archive
will appear along the x-axis, and the second will be along the
y-axis. To switch this behavior (i.e. to transpose the axes), set
Expand Down

0 comments on commit fed039e

Please sign in to comment.