neulab/docprompting-conala huggingface dataset:
plot_wireframe(X, Y, Z, *args, **kwargs)[source]
 
Plot a 3D wireframe.  Note The rcount and ccount kwargs, which both default to 50, determine the maximum number of samples used in each direction. If the input data is larger, it will be downsampled (by slicing) to these numbers of points.   Parameters 
 
X, Y, Z2D arrays


Data values.  
rcount, ccountint


Maximum number of samples used in each direction. If the input data is larger, it will be downsampled (by slicing) to these numbers of points. Setting a count to zero causes the data to be not sampled in the corresponding direction, producing a 3D line plot rather than a wireframe plot. Defaults to 50.  
rstride, cstrideint


Downsampling stride in each direction. These arguments are mutually exclusive with rcount and ccount. If only one of rstride or cstride is set, the other defaults to 1. Setting a stride to zero causes the data to be not sampled in the corresponding direction, producing a 3D line plot rather than a wireframe plot. 'classic' mode uses a default of rstride = cstride = 1 instead of the new default of rcount = ccount = 50.  **kwargs

Other arguments are forwarded to Line3DCollection.
quiver(X, Y, Z, U, V, W, /, length=1, arrow_length_ratio=.3, pivot='tail', normalize=False, **kwargs)[source]
 
Plot a 3D field of arrows. The arguments could be array-like or scalars, so long as they they can be broadcast together. The arguments can also be masked arrays. If an element in any of argument is masked, then that corresponding quiver element will not be plotted.  Parameters 
 
X, Y, Zarray-like


The x, y and z coordinates of the arrow locations (default is tail of arrow; see pivot kwarg).  
U, V, Warray-like


The x, y and z components of the arrow vectors.  
lengthfloat, default: 1


The length of each quiver.  
arrow_length_ratiofloat, default: 0.3


The ratio of the arrow head with respect to the quiver.  
pivot{'tail', 'middle', 'tip'}, default: 'tail'


The part of the arrow that is at the grid point; the arrow rotates about this point, hence the name pivot.  
normalizebool, default: False


Whether all arrows are normalized to have the same length, or keep the lengths defined by u, v, and w.  
dataindexable object, optional


If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).  **kwargs

Any additional keyword arguments are delegated to LineCollection
quiver3D(X, Y, Z, U, V, W, /, length=1, arrow_length_ratio=.3, pivot='tail', normalize=False, **kwargs)[source]
 
Plot a 3D field of arrows. The arguments could be array-like or scalars, so long as they they can be broadcast together. The arguments can also be masked arrays. If an element in any of argument is masked, then that corresponding quiver element will not be plotted.  Parameters 
 
X, Y, Zarray-like


The x, y and z coordinates of the arrow locations (default is tail of arrow; see pivot kwarg).  
U, V, Warray-like


The x, y and z components of the arrow vectors.  
lengthfloat, default: 1


The length of each quiver.  
arrow_length_ratiofloat, default: 0.3


The ratio of the arrow head with respect to the quiver.  
pivot{'tail', 'middle', 'tip'}, default: 'tail'


The part of the arrow that is at the grid point; the arrow rotates about this point, hence the name pivot.  
normalizebool, default: False


Whether all arrows are normalized to have the same length, or keep the lengths defined by u, v, and w.  
dataindexable object, optional


If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).  **kwargs

Any additional keyword arguments are delegated to LineCollection
scatter(xs, ys, zs=0, zdir='z', s=20, c=None, depthshade=True, *args, data=None, **kwargs)[source]
 
Create a scatter plot.  Parameters 
 
xs, ysarray-like


The data positions.  
zsfloat or array-like, default: 0


The z-positions. Either an array of the same length as xs and ys or a single value to place all points in the same plane.  
zdir{'x', 'y', 'z', '-x', '-y', '-z'}, default: 'z'


The axis direction for the zs. This is useful when plotting 2D data on a 3D Axes. The data must be passed as xs, ys. Setting zdir to 'y' then plots the data to the x-z-plane. See also Plot 2D data on 3D plot.  
sfloat or array-like, default: 20


The marker size in points**2. Either an array of the same length as xs and ys or a single value to make all markers the same size.  
ccolor, sequence, or sequence of colors, optional


The marker color. Possible values:  A single color format string. A sequence of colors of length n. A sequence of n numbers to be mapped to colors using cmap and norm. A 2D array in which the rows are RGB or RGBA.  For more details see the c argument of scatter.  
depthshadebool, default: True


Whether to shade the scatter markers to give the appearance of depth. Each call to scatter() will perform its depthshading independently.  
dataindexable object, optional


If given, the following parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception): xs, ys, zs, s, edgecolors, c, facecolor, facecolors, color  **kwargs

All other arguments are passed on to scatter.    Returns 
 
pathsPathCollection
scatter3D(xs, ys, zs=0, zdir='z', s=20, c=None, depthshade=True, *args, data=None, **kwargs)[source]
 
Create a scatter plot.  Parameters 
 
xs, ysarray-like


The data positions.  
zsfloat or array-like, default: 0


The z-positions. Either an array of the same length as xs and ys or a single value to place all points in the same plane.  
zdir{'x', 'y', 'z', '-x', '-y', '-z'}, default: 'z'


The axis direction for the zs. This is useful when plotting 2D data on a 3D Axes. The data must be passed as xs, ys. Setting zdir to 'y' then plots the data to the x-z-plane. See also Plot 2D data on 3D plot.  
sfloat or array-like, default: 20


The marker size in points**2. Either an array of the same length as xs and ys or a single value to make all markers the same size.  
ccolor, sequence, or sequence of colors, optional


The marker color. Possible values:  A single color format string. A sequence of colors of length n. A sequence of n numbers to be mapped to colors using cmap and norm. A 2D array in which the rows are RGB or RGBA.  For more details see the c argument of scatter.  
depthshadebool, default: True


Whether to shade the scatter markers to give the appearance of depth. Each call to scatter() will perform its depthshading independently.  
dataindexable object, optional


If given, the following parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception): xs, ys, zs, s, edgecolors, c, facecolor, facecolors, color  **kwargs

All other arguments are passed on to scatter.    Returns 
 
pathsPathCollection
set(*, adjustable=<UNSET>, agg_filter=<UNSET>, alpha=<UNSET>, anchor=<UNSET>, animated=<UNSET>, aspect=<UNSET>, autoscale_on=<UNSET>, autoscalex_on=<UNSET>, autoscaley_on=<UNSET>, autoscalez_on=<UNSET>, axes_locator=<UNSET>, axisbelow=<UNSET>, box_aspect=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, facecolor=<UNSET>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, proj_type=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xlim3d=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<UNSET>, ylabel=<UNSET>, ylim=<UNSET>, ylim3d=<UNSET>, ymargin=<UNSET>, yscale=<UNSET>, yticklabels=<UNSET>, yticks=<UNSET>, zbound=<UNSET>, zlabel=<UNSET>, zlim3d=<UNSET>, zmargin=<UNSET>, zorder=<UNSET>, zscale=<UNSET>, zticklabels=<UNSET>, zticks=<UNSET>)[source]
 
Set multiple properties at once. Supported properties are   
Property Description   
adjustable {'box', 'datalim'}  
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array  
alpha scalar or None  
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}  
animated bool  
aspect {'auto'}  
autoscale_on unknown  
autoscalex_on bool  
autoscaley_on bool  
autoscalez_on bool  
axes_locator Callable[[Axes, Renderer], Bbox]  
axisbelow bool or 'line'  
box_aspect 3-tuple of floats or None  
clip_box Bbox  
clip_on bool  
clip_path Patch or (Path, Transform) or None  
facecolor or fc color  
figure Figure  
frame_on bool  
gid str  
in_layout bool  
label object  
navigate bool  
navigate_mode unknown  
path_effects AbstractPathEffect  
picker None or bool or float or callable  
position [left, bottom, width, height] or Bbox  
proj_type {'persp', 'ortho'}  
prop_cycle unknown  
rasterization_zorder float or None  
rasterized bool  
sketch_params (scale: float, length: float, randomness: float)  
snap bool or None  
title unknown  
transform Transform  
url str  
visible bool  
xbound unknown  
xlabel str  
xlim (bottom: float, top: float)  
xlim3d unknown  
xmargin unknown  
xscale {"linear"}  
xticklabels unknown  
xticks unknown  
ybound unknown  
ylabel str  
ylim (bottom: float, top: float)  
ylim3d unknown  
ymargin unknown  
yscale {"linear"}  
yticklabels unknown  
yticks unknown  
zbound unknown  
zlabel unknown  
zlim3d unknown  
zmargin unknown  
zorder float  
zscale {"linear"}  
zticklabels unknown  
zticks unknown
set_aspect(aspect, adjustable=None, anchor=None, share=False)[source]
 
Set the aspect ratios. Axes 3D does not current support any aspect but 'auto' which fills the axes with the data limits. To simulate having equal aspect in data space, set the ratio of your data limits to match the value of get_box_aspect. To control box aspect ratios use set_box_aspect.  Parameters 
 
aspect{'auto'}


Possible values:   
value description   
'auto' automatic; fill the position rectangle with data.    
adjustableNone


Currently ignored by Axes3D If not None, this defines which parameter will be adjusted to meet the required aspect. See set_adjustable for further details.  
anchorNone or str or 2-tuple of float, optional


If not None, this defines where the Axes will be drawn if there is extra space due to aspect constraints. The most common way to to specify the anchor are abbreviations of cardinal directions:   
value description   
'C' centered  
'SW' lower left corner  
'S' middle of bottom edge  
'SE' lower right corner  
etc.    See set_anchor for further details.  
sharebool, default: False


If True, apply the settings to all shared Axes.      See also  mpl_toolkits.mplot3d.axes3d.Axes3D.set_box_aspect
set_autoscale_on(b)[source]
 
Set whether autoscaling is applied to each axis on the next draw or call to Axes.autoscale_view.  Parameters 
 
bbool
set_autoscalez_on(b)[source]
 
Set whether the z-axis is autoscaled on the next draw or call to Axes.autoscale_view.  Parameters 
 
bbool
set_axis_off()[source]
 
Turn the x- and y-axis off. This affects the axis lines, ticks, ticklabels, grid and axis labels.
set_axis_on()[source]
 
Turn the x- and y-axis on. This affects the axis lines, ticks, ticklabels, grid and axis labels.
set_box_aspect(aspect, *, zoom=1)[source]
 
Set the axes box aspect. The box aspect is the ratio of height to width in display units for each face of the box when viewed perpendicular to that face. This is not to be confused with the data aspect (which for Axes3D is always 'auto'). The default ratios are 4:4:3 (x:y:z). To simulate having equal aspect in data space, set the box aspect to match your data range in each dimension. zoom controls the overall size of the Axes3D in the figure.  Parameters 
 
aspect3-tuple of floats or None


Changes the physical dimensions of the Axes3D, such that the ratio of the axis lengths in display units is x:y:z. If None, defaults to 4:4:3  
zoomfloat


Control overall size of the Axes3D in the figure.
set_frame_on(b)[source]
 
Set whether the 3D axes panels are drawn.  Parameters 
 
bbool
set_proj_type(proj_type)[source]
 
Set the projection type.  Parameters 
 
proj_type{'persp', 'ortho'}
set_title(label, fontdict=None, loc='center', **kwargs)[source]
 
Set a title for the Axes. Set one of the three available Axes titles. The available titles are positioned above the Axes in the center, flush with the left edge, and flush with the right edge.  Parameters 
 
labelstr


Text to use for the title  
fontdictdict


A dictionary controlling the appearance of the title text, the default fontdict is: {'fontsize': rcParams['axes.titlesize'],
 'fontweight': rcParams['axes.titleweight'],
 'color': rcParams['axes.titlecolor'],
 'verticalalignment': 'baseline',
 'horizontalalignment': loc}
  
loc{'center', 'left', 'right'}, default: rcParams["axes.titlelocation"] (default: 'center')


Which title to set.  
yfloat, default: rcParams["axes.titley"] (default: None)


Vertical Axes loation for the title (1.0 is the top). If None (the default), y is determined automatically to avoid decorators on the Axes.  
padfloat, default: rcParams["axes.titlepad"] (default: 6.0)


The offset of the title from the top of the Axes, in points.    Returns 
 Text

The matplotlib text instance representing the title    Other Parameters 
 
**kwargsText properties


Other keyword arguments are text properties, see Text for a list of valid text properties.
set_xlim(left=None, right=None, emit=True, auto=False, *, xmin=None, xmax=None)[source]
 
Alias for set_xlim3d.
set_xlim3d(left=None, right=None, emit=True, auto=False, *, xmin=None, xmax=None)[source]
 
Set 3D x limits. See matplotlib.axes.Axes.set_xlim() for full documentation.
set_xmargin(m)[source]
 
Set padding of X data limits prior to autoscaling. m times the data interval will be added to each end of that interval before it is used in autoscaling. For example, if your data is in the range [0, 2], a factor of m = 0.1 will result in a range [-0.2, 2.2]. Negative values -0.5 < m < 0 will result in clipping of the data range. I.e. for a data range [0, 2], a factor of m = -0.1 will result in a range [0.2, 1.8].  Parameters 
 
mfloat greater than -0.5
set_xscale(value, **kwargs)[source]
 
Set the x-axis scale.  Parameters 
 
value{"linear"}


The axis scale type to apply. 3D axes currently only support linear scales; other scales yield nonsensical results.  **kwargs

Keyword arguments are nominally forwarded to the scale class, but none of them is applicable for linear scales.
set_ylim(bottom=None, top=None, emit=True, auto=False, *, ymin=None, ymax=None)[source]
 
Alias for set_ylim3d.
set_ylim3d(bottom=None, top=None, emit=True, auto=False, *, ymin=None, ymax=None)[source]
 
Set 3D y limits. See matplotlib.axes.Axes.set_ylim() for full documentation.
set_ymargin(m)[source]
 
Set padding of Y data limits prior to autoscaling. m times the data interval will be added to each end of that interval before it is used in autoscaling. For example, if your data is in the range [0, 2], a factor of m = 0.1 will result in a range [-0.2, 2.2]. Negative values -0.5 < m < 0 will result in clipping of the data range. I.e. for a data range [0, 2], a factor of m = -0.1 will result in a range [0.2, 1.8].  Parameters 
 
mfloat greater than -0.5
set_yscale(value, **kwargs)[source]
 
Set the y-axis scale.  Parameters 
 
value{"linear"}


The axis scale type to apply. 3D axes currently only support linear scales; other scales yield nonsensical results.  **kwargs

Keyword arguments are nominally forwarded to the scale class, but none of them is applicable for linear scales.
set_zbound(lower=None, upper=None)[source]
 
Set the lower and upper numerical bounds of the z-axis. This method will honor axes inversion regardless of parameter order. It will not change the autoscaling setting (get_autoscalez_on()).
set_zlabel(zlabel, fontdict=None, labelpad=None, **kwargs)[source]
 
Set zlabel. See doc for set_ylabel for description.
set_zlim(bottom=None, top=None, emit=True, auto=False, *, zmin=None, zmax=None)[source]
 
Alias for set_zlim3d.
set_zlim3d(bottom=None, top=None, emit=True, auto=False, *, zmin=None, zmax=None)[source]
 
Set 3D z limits. See matplotlib.axes.Axes.set_ylim() for full documentation
set_zmargin(m)[source]
 
Set padding of Z data limits prior to autoscaling. m times the data interval will be added to each end of that interval before it is used in autoscaling. accepts: float in range 0 to 1
set_zscale(value, **kwargs)[source]
 
Set the z-axis scale.  Parameters 
 
value{"linear"}


The axis scale type to apply. 3D axes currently only support linear scales; other scales yield nonsensical results.  **kwargs

Keyword arguments are nominally forwarded to the scale class, but none of them is applicable for linear scales.
set_zticklabels(labels, *, fontdict=None, minor=False, **kwargs)[source]
 
Set the zaxis' labels with list of string labels.  Warning This method should only be used after fixing the tick positions using Axes3D.set_zticks. Otherwise, the labels may end up in unexpected positions.   Parameters 
 
labelslist of str


The label texts.  
fontdictdict, optional


A dictionary controlling the appearance of the ticklabels. The default fontdict is: {'fontsize': rcParams['axes.titlesize'],
 'fontweight': rcParams['axes.titleweight'],
 'verticalalignment': 'baseline',
 'horizontalalignment': loc}
  
minorbool, default: False


Whether to set the minor ticklabels rather than the major ones.    Returns 
 list of Text


The labels.    Other Parameters 
 
**kwargsText properties.
set_zticks(ticks, labels=None, *, minor=False, **kwargs)[source]
 
Set the zaxis' tick locations and optionally labels. If necessary, the view limits of the Axis are expanded so that all given ticks are visible.  Parameters 
 
tickslist of floats


List of tick locations.  
labelslist of str, optional


List of tick labels. If not set, the labels show the data value.  
minorbool, default: False


If False, set the major ticks; if True, the minor ticks.  **kwargs

Text properties for the labels. These take effect only if you pass labels. In other cases, please use tick_params.     Notes The mandatory expansion of the view limits is an intentional design choice to prevent the surprise of a non-visible tick. If you need other limits, you should set the limits explicitly after setting the ticks.
stem(x, y, z, *, linefmt='C0-', markerfmt='C0o', basefmt='C3-', bottom=0, label=None, orientation='z', data=None)[source]
 
Create a 3D stem plot. A stem plot draws lines perpendicular to a baseline, and places markers at the heads. By default, the baseline is defined by x and y, and stems are drawn vertically from bottom to z.  Parameters 
 
x, y, zarray-like


The positions of the heads of the stems. The stems are drawn along the orientation-direction from the baseline at bottom (in the orientation-coordinate) to the heads. By default, the x and y positions are used for the baseline and z for the head position, but this can be changed by orientation.  
linefmtstr, default: 'C0-'


A string defining the properties of the vertical lines. Usually, this will be a color or a color and a linestyle:   
Character Line Style   
'-' solid line  
'--' dashed line  
'-.' dash-dot line  
':' dotted line   Note: While it is technically possible to specify valid formats other than color or color and linestyle (e.g. 'rx' or '-.'), this is beyond the intention of the method and will most likely not result in a reasonable plot.  
markerfmtstr, default: 'C0o'


A string defining the properties of the markers at the stem heads.  
basefmtstr, default: 'C3-'


A format string defining the properties of the baseline.  
bottomfloat, default: 0


The position of the baseline, in orientation-coordinates.  
labelstr, default: None


The label to use for the stems in legends.  
orientation{'x', 'y', 'z'}, default: 'z'


The direction along which stems are drawn.  
dataindexable object, optional


If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).    Returns 
 StemContainer

The container may be treated like a tuple (markerline, stemlines, baseline)     Examples (Source code, png, pdf)    (png, pdf)    (png, pdf)
stem3D(x, y, z, *, linefmt='C0-', markerfmt='C0o', basefmt='C3-', bottom=0, label=None, orientation='z', data=None)[source]
 
Create a 3D stem plot. A stem plot draws lines perpendicular to a baseline, and places markers at the heads. By default, the baseline is defined by x and y, and stems are drawn vertically from bottom to z.  Parameters 
 
x, y, zarray-like


The positions of the heads of the stems. The stems are drawn along the orientation-direction from the baseline at bottom (in the orientation-coordinate) to the heads. By default, the x and y positions are used for the baseline and z for the head position, but this can be changed by orientation.  
linefmtstr, default: 'C0-'


A string defining the properties of the vertical lines. Usually, this will be a color or a color and a linestyle:   
Character Line Style   
'-' solid line  
'--' dashed line  
'-.' dash-dot line  
':' dotted line   Note: While it is technically possible to specify valid formats other than color or color and linestyle (e.g. 'rx' or '-.'), this is beyond the intention of the method and will most likely not result in a reasonable plot.  
markerfmtstr, default: 'C0o'


A string defining the properties of the markers at the stem heads.  
basefmtstr, default: 'C3-'


A format string defining the properties of the baseline.  
bottomfloat, default: 0


The position of the baseline, in orientation-coordinates.  
labelstr, default: None


The label to use for the stems in legends.  
orientation{'x', 'y', 'z'}, default: 'z'


The direction along which stems are drawn.  
dataindexable object, optional


If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).    Returns 
 StemContainer

The container may be treated like a tuple (markerline, stemlines, baseline)     Examples (Source code, png, pdf)    (png, pdf)    (png, pdf)
text(x, y, z, s, zdir=None, **kwargs)[source]
 
Add text to the plot. kwargs will be passed on to Axes.text, except for the zdir keyword, which sets the direction to be used as the z direction.
text3D(x, y, z, s, zdir=None, **kwargs)[source]
 
Add text to the plot. kwargs will be passed on to Axes.text, except for the zdir keyword, which sets the direction to be used as the z direction.
tick_params(axis='both', **kwargs)[source]
 
Convenience method for changing the appearance of ticks and tick labels. See matplotlib.axes.Axes.tick_params() for more complete documentation. The only difference is that setting axis to 'both' will mean that the settings are applied to all three axes. Also, the axis parameter also accepts a value of 'z', which would mean to apply to only the z-axis. Also, because of how Axes3D objects are drawn very differently from regular 2D axes, some of these settings may have ambiguous meaning. For simplicity, the 'z' axis will accept settings as if it was like the 'y' axis.  Note Axes3D currently ignores some of these settings.
tricontour(*args, extend3d=False, stride=5, zdir='z', offset=None, data=None, **kwargs)[source]
 
Create a 3D contour plot.  Note This method currently produces incorrect output due to a longstanding bug in 3D PolyCollection rendering.   Parameters 
 
X, Y, Zarray-like


Input data. See tricontour for acceptable data shapes.  
extend3dbool, default: False


Whether to extend contour in 3D.  
strideint


Step size for extending contour.  
zdir{'x', 'y', 'z'}, default: 'z'


The direction to use.  
offsetfloat, optional


If specified, plot a projection of the contour lines at this position in a plane normal to zdir.  
dataindexable object, optional


If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).  *args, **kwargs

Other arguments are forwarded to matplotlib.axes.Axes.tricontour.    Returns 
 matplotlib.tri.tricontour.TriContourSet