fiftyone.core.plots.base

module documentation

(source)

Base plotting definitions.

Class	`InteractivePlot`	Base class for plots that support selection of their points.
Class	`Plot`	Base class for all plots.
Class	`ResponsivePlot`	Base class for all responsive plots that can push/pull updates to a linked object.
Class	`ViewPlot`	Base class for plots that can be automatically populated given a `fiftyone.core.collections.SampleCollection` instance.
Function	`lines`	Plots the given lines(s) data.
Function	`location_scatterplot`	Generates an interactive scatterplot of the given location coordinates with a map rendered in the background of the plot.
Function	`plot_confusion_matrix`	Plots a confusion matrix.
Function	`plot_pr_curve`	Plots a precision-recall (PR) curve.
Function	`plot_pr_curves`	Plots a set of per-class precision-recall (PR) curves.
Function	`plot_regressions`	Plots the given regression results.
Function	`plot_roc_curve`	Plots a receiver operating characteristic (ROC) curve.
Function	`scatterplot`	Generates an interactive scatterplot of the given points.
Variable	`logger`	Undocumented
Function	`_parse_backend`	Undocumented

def lines(x=None, y=None, samples=None, ids=None, link_field=None, sizes=None, backend='plotly', **kwargs): (source) ¶

Plots the given lines(s) data.

You can attach plots generated by this method to an App session via its fiftyone.core.session.Session.plots attribute, which will automatically sync the session's view with the currently selected points in the plot. To enable this functionality, you must pass samples to this method.

You can use the sizes parameter to scale the sizes of the points.

Parameters
x:`None`	the x data to plot. Can be any of the following: an array-like of values a `num_lines x n` array-like or list of length `num_lines` of array-likes of values for multiple line traces the name of a sample field or `embedded.field.name` of `samples` from which to extract values for a single line the name of a frame field or `frames.embedded.field.name` of `samples` from which to extract values for per-sample line traces a `fiftyone.core.expressions.ViewExpression` that resolves to a list (one line plot) or list of lists (multiple line plots) of numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values`
y:`None`	the y data to plot. Can be any of the following: an array-like of values a `num_lines x n` array-like or list of length `num_lines` of array-likes of values for multiple line traces the name of a sample field or `embedded.field.name` of `samples` from which to extract values for a single line the name of a frame field or `frames.embedded.field.name` of `samples` from which to extract values for per-sample line traces a `fiftyone.core.expressions.ViewExpression` that resolves to a list (one line plot) or list of lists (multiple line plots) of numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values`
samples:`None`	the `fiftyone.core.collections.SampleCollection` whose data is being visualized
ids:`None`	an array-like of IDs of same shape as `y`. If not provided but `samples` are provided, the appropriate IDs will be extracted from the samples
link_field:`None`	a field of `samples` whose data corresponds to `y`. Can be any of the following: `None`, if the line data correspond to samples (single trace) or frames (multiple traces) `"frames"`, if the line data correspond to frames (multiple traces). This option exists only for consistency with other plotting methods; in practice, it will be automatically inferred whenever multiple traces are being plotted the name of a `fiftyone.core.labels.Label` field, if the line data correspond to the labels in this field
sizes:`None`	data to use to scale the sizes of the points. Can be any of the following: an array-like of numeric values of same shape as `y` the name of a sample field (single trace) or frame field (multiple traces) from which to extract numeric values a `fiftyone.core.expressions.ViewExpression` defining sample-level (single trace) or frame-level (multiple traces) numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values`
backend:"plotly"	the plotting backend to use. Supported values are `("plotly", "matplotlib")`
**kwargs	keyword arguments for the backend plotting method: "plotly" backend: `fiftyone.core.plots.plotly.lines` "matplotlib" backend: `fiftyone.core.plots.matplotlib.lines`
Returns
one of the following an `InteractivePlot`, if IDs are available a `fiftyone.core.plots.plotly.PlotlyNotebookPlot`, if IDs are not available but you are working with the plotly backend in a Jupyter notebook a plotly or matplotlib figure, otherwise

def location_scatterplot(locations=None, samples=None, ids=None, labels=None, sizes=None, classes=None, backend='plotly', **kwargs): (source) ¶

Generates an interactive scatterplot of the given location coordinates with a map rendered in the background of the plot.

Location data is specified via the locations parameter.

You can use the labels parameters to define a coloring for the points, and you can use the sizes parameter to scale the sizes of the points.

Parameters
locations:`None`	the location data to plot. Can be any of the following: None, in which case `samples` must have a single `fiftyone.core.labels.GeoLocation` field whose `point` attribute contains location data a `num_locations x 2` array of `(longitude, latitude)` coordinates the name of a `fiftyone.core.labels.GeoLocation` field of `samples` with `(longitude, latitude)` coordinates in its `point` attribute
samples:`None`	the `fiftyone.core.collections.SampleCollection` whose data is being visualized
ids:`None`	an array-like of IDs corresponding to the locations. If not provided but `samples` are provided, the appropriate IDs will be extracted from the samples
labels:`None`	data to use to color the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric or string values a `fiftyone.core.expressions.ViewExpression` defining numeric or string values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric or string values
sizes:`None`	data to use to scale the sizes of the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric values a `fiftyone.core.expressions.ViewExpression` defining numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric values
classes:`None`	a list of classes whose points to plot. Only applicable when `labels` contains strings
backend:"plotly"	the plotting backend to use. Supported values are `("plotly", "matplotlib")`
**kwargs	keyword arguments for the backend plotting method: "plotly" backend: `fiftyone.core.plots.plotly.location_scatterplot` "matplotlib" backend: `fiftyone.core.plots.matplotlib.location_scatterplot`
Returns
one of the following an `InteractivePlot`, if IDs are available a `fiftyone.core.plots.plotly.PlotlyNotebookPlot`, if IDs are not available but you are working with the plotly backend in a Jupyter notebook a plotly or matplotlib figure, otherwise

def plot_confusion_matrix(confusion_matrix, labels, ids=None, samples=None, eval_key=None, gt_field=None, pred_field=None, backend='plotly', **kwargs): (source) ¶

Plots a confusion matrix.

If ids are provided and you are working in a notebook environment with the default plotly backend, this method returns an interactive fiftyone.core.plots.plotly.InteractiveHeatmap that you can attach to an App session via its fiftyone.core.session.Session.plots attribute, which will automatically sync the session's view with the currently selected cells in the confusion matrix.

Parameters
confusion_matrix	a `num_true x num_preds` confusion matrix
labels	a `max(num_true, num_preds)` array-like of class labels
ids:`None`	an array-like of same shape as `confusion_matrix` containing lists of IDs corresponding to each cell
samples:`None`	the `fiftyone.core.collections.SampleCollection` for which the confusion matrix was generated
eval_key:`None`	the evaluation key of the evaluation
gt_field:`None`	the name of the ground truth field
pred_field:`None`	the name of the predictions field
backend:"plotly"	the plotting backend to use. Supported values are `("plotly", "matplotlib")`
**kwargs	keyword arguments for the backend plotting method: "plotly" backend: `fiftyone.core.plots.plotly.plot_confusion_matrix` "matplotlib" backend: `fiftyone.core.plots.matplotlib.plot_confusion_matrix`
Returns
one of the following a `fiftyone.core.plots.plotly.InteractiveHeatmap`, if IDs are available and the plotly backend is used a `fiftyone.core.plots.plotly.PlotlyNotebookPlot`, if no IDs are available but you are working in a Jupyter notebook with the plotly backend a plotly or matplotlib figure, otherwise

def plot_pr_curve(precision, recall, thresholds=None, label=None, backend='plotly', **kwargs): (source) ¶

Plots a precision-recall (PR) curve.

Parameters
precision	an array-like of precision values
recall	an array-like of recall values
thresholds:`None`	an array-like of decision thresholds
label:`None`	a label for the curve
backend:"plotly"	the plotting backend to use. Supported values are `("plotly", "matplotlib")`
**kwargs	keyword arguments for the backend plotting method: "plotly" backend: `fiftyone.core.plots.plotly.plot_pr_curve` "matplotlib" backend: `fiftyone.core.plots.matplotlib.plot_pr_curve`
Returns
one of the following a `fiftyone.core.plots.plotly.PlotlyNotebookPlot`, if you are working in a Jupyter notebook and the plotly backend is used a plotly or matplotlib figure, otherwise

def plot_pr_curves(precisions, recall, classes, thresholds=None, backend='plotly', **kwargs): (source) ¶

Plots a set of per-class precision-recall (PR) curves.

Parameters
precisions	a `num_classes x num_recalls` array-like of per-class precision values
recall	an array-like of recall values
classes	the list of classes
thresholds:`None`	an `num_classes x num_recalls` array-like of decision thresholds
backend:"plotly"	the plotting backend to use. Supported values are `("plotly", "matplotlib")`
**kwargs	keyword arguments for the backend plotting method: "plotly" backend: `fiftyone.core.plots.plotly.plot_pr_curves` "matplotlib" backend: `fiftyone.core.plots.matplotlib.plot_pr_curves`
Returns
one of the following a `fiftyone.core.plots.plotly.PlotlyNotebookPlot`, if you are working in a Jupyter notebook and the plotly backend is used a plotly or matplotlib figure, otherwise

def plot_regressions(ytrue, ypred, samples=None, ids=None, labels=None, sizes=None, classes=None, gt_field=None, pred_field=None, backend='plotly', **kwargs): (source) ¶

Plots the given regression results.

If IDs are provided and you are working in a notebook environment with the default plotly backend, this method returns an interactive fiftyone.core.plots.plotly.InteractiveScatter that you can attach to an App session via its fiftyone.core.session.Session.plots attribute, which will automatically sync the session's view with the currently selected points in the plot.

Parameters
ytrue	an array-like of ground truth values
ypred	an array-like of predicted values
samples:`None`	the `fiftyone.core.collections.SampleCollection` for which the results were generated. Only used by the "plotly" backend when IDs are provided
ids:`None`	an array-like of sample or frame IDs corresponding to the regressions. If not provided but `samples` are provided, the appropriate IDs will be extracted from the samples
labels:`None`	data to use to color the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric or string values a `fiftyone.core.expressions.ViewExpression` defining numeric or string values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric or string values a list of array-likes of numeric or string values, if `link_field` refers to frames
sizes:`None`	data to use to scale the sizes of the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric values a `fiftyone.core.expressions.ViewExpression` defining numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric values a list of array-likes of numeric or string values, if `link_field` refers to frames
classes:`None`	a list of classes whose points to plot. Only applicable when `labels` contains strings
gt_field:`None`	the name of the ground truth field
pred_field:`None`	the name of the predictions field
backend:"plotly"	the plotting backend to use. Supported values are `("plotly", "matplotlib")`
**kwargs	keyword arguments for the backend plotting method: "plotly" backend: `fiftyone.core.plots.plotly.plot_confusion_matrix` "matplotlib" backend: `fiftyone.core.plots.matplotlib.plot_confusion_matrix`
Returns
one of the following a `fiftyone.core.plots.plotly.InteractiveScatter`, if IDs are available and the plotly backend is used a `fiftyone.core.plots.plotly.PlotlyNotebookPlot`, if no IDs are available but you are working in a Jupyter notebook with the plotly backend a plotly or matplotlib figure, otherwise

def plot_roc_curve(fpr, tpr, thresholds=None, roc_auc=None, backend='plotly', **kwargs): (source) ¶

Plots a receiver operating characteristic (ROC) curve.

Parameters
fpr	an array-like of false positive rates
tpr	an array-like of true positive rates
thresholds:`None`	an array-like of decision thresholds
roc_auc:`None`	the area under the ROC curve
backend:"plotly"	the plotting backend to use. Supported values are `("plotly", "matplotlib")`
**kwargs	keyword arguments for the backend plotting method: "plotly" backend: `fiftyone.core.plots.plotly.plot_roc_curve` "matplotlib" backend: `fiftyone.core.plots.matplotlib.plot_roc_curve`
Returns
one of the following a `fiftyone.core.plots.plotly.PlotlyNotebookPlot`, if you are working in a Jupyter notebook and the plotly backend is used a plotly or matplotlib figure, otherwise

def scatterplot(points, samples=None, ids=None, link_field=None, labels=None, sizes=None, classes=None, backend='plotly', **kwargs): (source) ¶

Generates an interactive scatterplot of the given points.

This method supports 2D or 3D visualizations, but interactive point selection is only available in 2D.

You can use the labels parameters to define a coloring for the points, and you can use the sizes parameter to scale the sizes of the points.

Parameters
points	a `num_points x num_dims` array-like of points
samples:`None`	the `fiftyone.core.collections.SampleCollection` whose data is being visualized
ids:`None`	an array-like of IDs corresponding to the points. If not provided but `samples` are provided, the appropriate IDs will be extracted from the samples
link_field:`None`	a field of `samples` whose data corresponds to `points`. Can be any of the following: None, if the points correspond to samples `"frames"`, if the points correspond to frames the name of a `fiftyone.core.labels.Label` field, if the points linked to the labels in this field
labels:`None`	data to use to color the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric or string values a `fiftyone.core.expressions.ViewExpression` defining numeric or string values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric or string values a list of array-likes of numeric or string values, if `link_field` refers to a label list field like `fiftyone.core.labels.Detections`
sizes:`None`	data to use to scale the sizes of the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric values a `fiftyone.core.expressions.ViewExpression` defining numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric values a list of array-likes of numeric or string values, if `link_field` refers to a label list field like `fiftyone.core.labels.Detections`
classes:`None`	an list of classes whose points to plot. Only applicable when `labels` contains strings
backend:"plotly"	the plotting backend to use. Supported values are `("plotly", "matplotlib")`
**kwargs	keyword arguments for the backend plotting method: "plotly" backend: `fiftyone.core.plots.plotly.scatterplot` "matplotlib" backend: `fiftyone.core.plots.matplotlib.scatterplot`
Returns
one of the following an `InteractivePlot`, if IDs are available a `fiftyone.core.plots.plotly.PlotlyNotebookPlot`, if IDs are not available but you are working with the plotly backend in a Jupyter notebook a plotly or matplotlib figure, otherwise

logger = (source) ¶

Undocumented

def _parse_backend(backend): (source) ¶

Undocumented