neulab/docprompting-conala huggingface dataset:
setup(fig, outfile, dpi, frame_dir=None)[source]
 
Setup for writing the movie file.  Parameters 
 
figFigure


The figure to grab the rendered frames from.  
outfilestr


The filename of the resulting movie file.  
dpifloat, default: fig.dpi


The dpi of the output file. This, with the figure size, controls the size in pixels of the resulting movie file.  
frame_prefixstr, optional


The filename prefix to use for temporary files. If None (the default), files are written to a temporary directory which is deleted by cleanup; if not None, no temporary files are deleted.
matplotlib.animation.ImageMagickBase   classmatplotlib.animation.ImageMagickBase[source]
 
Mixin class for ImageMagick output. To be useful this must be multiply-inherited from with a MovieWriterBase sub-class.   __init__(*args, **kwargs)

 Methods  
__init__(*args, **kwargs)   
bin_path()   
isAvailable()    Attributes  
delay   
output_args      classmethodbin_path()[source]

   propertydelay

   classmethodisAvailable()[source]

   propertyoutput_args
matplotlib.animation.ImageMagickFileWriter   classmatplotlib.animation.ImageMagickFileWriter(*args, **kwargs)[source]
 
File-based animated gif writer. Frames are written to temporary files on disk and then stitched together at the end.   __init__(*args, **kwargs)[source]

 Methods  
__init__(*args, **kwargs)   
bin_path() Return the binary path to the commandline tool used by a specific subclass.  
cleanup() [Deprecated]  
finish() Finish any processing for writing the movie.  
grab_frame(**savefig_kwargs) Grab the image information from the figure and save as a movie frame.  
isAvailable() Return whether a MovieWriter subclass is actually available.  
saving(fig, outfile, dpi, *args, **kwargs) Context manager to facilitate writing the movie file.  
setup(fig, outfile[, dpi, frame_prefix]) Setup for writing the movie file.   Attributes  
delay   
frame_format Format (png, jpeg, etc.) to use for saving the frames, which can be decided by the individual subclasses.  
frame_size A tuple (width, height) in pixels of a movie frame.  
output_args   
supported_formats      supported_formats=['png', 'jpeg', 'tiff', 'raw', 'rgba']
matplotlib.animation.ImageMagickWriter   classmatplotlib.animation.ImageMagickWriter(fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)[source]
 
Pipe-based animated gif. Frames are streamed directly to ImageMagick via a pipe and written in a single pass.  Parameters 
 
fpsint, default: 5


Movie frame rate (per second).  
codecstr or None, default: rcParams["animation.codec"] (default: 'h264')


The codec to use.  
bitrateint, default: rcParams["animation.bitrate"] (default: -1)


The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate.  
extra_argslist of str or None, optional


Extra command-line arguments passed to the underlying movie encoder. The default, None, means to use rcParams["animation.[name-of-encoder]_args"] for the builtin writers.  
metadatadict[str, str], default: {}


A dictionary of keys and values for metadata to include in the output file. Some keys that may be of use include: title, artist, genre, subject, copyright, srcform, comment.       __init__(fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)[source]
 
 Parameters 
 
fpsint, default: 5


Movie frame rate (per second).  
codecstr or None, default: rcParams["animation.codec"] (default: 'h264')


The codec to use.  
bitrateint, default: rcParams["animation.bitrate"] (default: -1)


The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate.  
extra_argslist of str or None, optional


Extra command-line arguments passed to the underlying movie encoder. The default, None, means to use rcParams["animation.[name-of-encoder]_args"] for the builtin writers.  
metadatadict[str, str], default: {}


A dictionary of keys and values for metadata to include in the output file. Some keys that may be of use include: title, artist, genre, subject, copyright, srcform, comment.     
 Methods  
__init__([fps, codec, bitrate, extra_args, ...]) 
 Parameters    
bin_path() Return the binary path to the commandline tool used by a specific subclass.  
cleanup() [Deprecated]  
finish() Finish any processing for writing the movie.  
grab_frame(**savefig_kwargs) Grab the image information from the figure and save as a movie frame.  
isAvailable() Return whether a MovieWriter subclass is actually available.  
saving(fig, outfile, dpi, *args, **kwargs) Context manager to facilitate writing the movie file.  
setup(fig, outfile[, dpi]) Setup for writing the movie file.   Attributes  
delay   
frame_size A tuple (width, height) in pixels of a movie frame.  
output_args   
supported_formats
classmethodbin_path()[source]
 
Return the binary path to the commandline tool used by a specific subclass. This is a class method so that the tool can be looked for before making a particular MovieWriter subclass available.
cleanup()[source]
 
[Deprecated] Notes  Deprecated since version 3.4:
setup(fig, outfile, dpi=None)[source]
 
Setup for writing the movie file.  Parameters 
 
figFigure


The figure object that contains the information for frames.  
outfilestr


The filename of the resulting movie file.  
dpifloat, default: fig.dpi


The DPI (or resolution) for the file. This controls the size in pixels of the resulting movie file.
matplotlib.animation.MovieWriterRegistry   classmatplotlib.animation.MovieWriterRegistry[source]
 
Registry of available writer classes by human readable name.   __init__()[source]

 Methods  
__init__()   
is_available(name) Check if given writer is available by name.  
list() Get a list of available MovieWriters.  
register(name) Decorator for registering a class under a name.     is_available(name)[source]
 
Check if given writer is available by name.  Parameters 
 
namestr

  Returns 
 bool
   
   list()[source]
 
Get a list of available MovieWriters. 
   register(name)[source]
 
Decorator for registering a class under a name. Example use: @registry.register(name)
class Foo:
    pass
is_available(name)[source]
 
Check if given writer is available by name.  Parameters 
 
namestr

  Returns 
 bool
register(name)[source]
 
Decorator for registering a class under a name. Example use: @registry.register(name)
class Foo:
    pass
matplotlib.animation.PillowWriter   classmatplotlib.animation.PillowWriter(fps=5, metadata=None, codec=None, bitrate=None)[source]
 
  __init__(fps=5, metadata=None, codec=None, bitrate=None)[source]

 Methods  
__init__([fps, metadata, codec, bitrate])   
finish() Finish any processing for writing the movie.  
grab_frame(**savefig_kwargs) Grab the image information from the figure and save as a movie frame.  
isAvailable()   
saving(fig, outfile, dpi, *args, **kwargs) Context manager to facilitate writing the movie file.  
setup(fig, outfile[, dpi]) Setup for writing the movie file.   Attributes  
frame_size A tuple (width, height) in pixels of a movie frame.     finish()[source]
 
Finish any processing for writing the movie. 
   grab_frame(**savefig_kwargs)[source]
 
Grab the image information from the figure and save as a movie frame. All keyword arguments in savefig_kwargs are passed on to the savefig call that saves the figure. 
   classmethodisAvailable()[source]

   setup(fig, outfile, dpi=None)[source]
 
Setup for writing the movie file.  Parameters 
 
figFigure


The figure object that contains the information for frames.  
outfilestr


The filename of the resulting movie file.  
dpifloat, default: fig.dpi


The DPI (or resolution) for the file. This controls the size in pixels of the resulting movie file.
matplotlib.animation.TimedAnimation   classmatplotlib.animation.TimedAnimation(fig, interval=200, repeat_delay=0, repeat=True, event_source=None, *args, **kwargs)[source]
 
Animation subclass for time-based animation. A new frame is drawn every interval milliseconds.  Note You must store the created Animation in a variable that lives as long as the animation should run. Otherwise, the Animation object will be garbage-collected and the animation stops.   Parameters 
 
figFigure


The figure object used to get needed events, such as draw or resize.  
intervalint, default: 200


Delay between frames in milliseconds.  
repeat_delayint, default: 0


The delay in milliseconds between consecutive animation runs, if repeat is True.  
repeatbool, default: True


Whether the animation repeats when the sequence of frames is completed.  
blitbool, default: False


Whether blitting is used to optimize drawing.       __init__(fig, interval=200, repeat_delay=0, repeat=True, event_source=None, *args, **kwargs)[source]

 Methods  
__init__(fig[, interval, repeat_delay, ...])   
new_frame_seq() Return a new sequence of frame information.  
new_saved_frame_seq() Return a new sequence of saved/cached frame information.  
pause() Pause the animation.  
resume() Resume the animation.  
save(filename[, writer, fps, dpi, codec, ...]) Save the animation as a movie file by drawing every frame.  
to_html5_video([embed_limit]) Convert the animation to an HTML5 <video> tag.  
to_jshtml([fps, embed_frames, default_mode]) Generate HTML representation of the animation.
__init__(fig, interval=200, repeat_delay=0, repeat=True, event_source=None, *args, **kwargs)[source]
matplotlib.artist.allow_rasterization   matplotlib.artist.allow_rasterization(draw)[source]
 
Decorator for Artist.draw method. Provides routines that run before and after the draw call. The before and after functions are useful for changing artist-dependent renderer attributes or making other setup function calls, such as starting and flushing a mixed-mode renderer.
classmatplotlib.artist.Artist[source]
 
Abstract base class for objects that render into a FigureCanvas. Typically, all visible elements in a figure are subclasses of Artist.
matplotlib.artist.Artist.add_callback   Artist.add_callback(func)[source]
 
Add a callback function that will be called whenever one of the Artist's properties changes.  Parameters 
 
funccallable


The callback function. It must have the signature: def func(artist: Artist) -> Any
 where artist is the calling Artist. Return values may exist but are ignored.    Returns 
 int

The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.      See also  remove_callback
matplotlib.artist.Artist.axes   propertyArtist.axes
 
The Axes instance the artist resides in, or None.
matplotlib.artist.Artist.contains   Artist.contains(mouseevent)[source]
 
Test whether the artist contains the mouse event.  Parameters 
 
mouseeventmatplotlib.backend_bases.MouseEvent

  Returns 
 
containsbool


Whether any values are within the radius.  
detailsdict


An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details.
matplotlib.artist.Artist.convert_xunits   Artist.convert_xunits(x)[source]
 
Convert x using the unit type of the xaxis. If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.
matplotlib.artist.Artist.convert_yunits   Artist.convert_yunits(y)[source]
 
Convert y using the unit type of the yaxis. If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.
matplotlib.artist.Artist.draw   Artist.draw(renderer)[source]
 
Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (Artist.get_visible returns False).  Parameters 
 
rendererRendererBase subclass.

   Notes This method is overridden in the Artist subclasses.
matplotlib.artist.Artist.findobj   Artist.findobj(match=None, include_self=True)[source]
 
Find artist objects. Recursively find all Artist instances contained in the artist.  Parameters 
 match

A filter criterion for the matches. This can be  
None: Return all objects contained in artist. A function with signature def match(artist: Artist) -> bool. The result will only contain artists for which the function returns True. A class instance: e.g., Line2D. The result will only contain artists of this class or its subclasses (isinstance check).   
include_selfbool


Include self in the list to be checked for a match.    Returns 
 list of Artist
matplotlib.artist.Artist.format_cursor_data   Artist.format_cursor_data(data)[source]
 
Return a string representation of data.  Note This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.  The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar's formatter.  See also  get_cursor_data
matplotlib.artist.Artist.get_agg_filter   Artist.get_agg_filter()[source]
 
Return filter function to be used for agg filter.
matplotlib.artist.Artist.get_alpha   Artist.get_alpha()[source]
 
Return the alpha value used for blending - not supported on all backends.
matplotlib.artist.Artist.get_animated   Artist.get_animated()[source]
 
Return whether the artist is animated.
matplotlib.artist.Artist.get_children   Artist.get_children()[source]
 
Return a list of the child Artists of this Artist.
matplotlib.artist.Artist.get_clip_box   Artist.get_clip_box()[source]
 
Return the clipbox.
matplotlib.artist.Artist.get_clip_on   Artist.get_clip_on()[source]
 
Return whether the artist uses clipping.
matplotlib.artist.Artist.get_clip_path   Artist.get_clip_path()[source]
 
Return the clip path.
matplotlib.artist.Artist.get_cursor_data   Artist.get_cursor_data(event)[source]
 
Return the cursor data for a given event.  Note This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.  Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None. Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that format_cursor_data can convert the data to a string representation. The only current use case is displaying the z-value of an AxesImage in the status bar of a plot window, while moving the mouse.  Parameters 
 
eventmatplotlib.backend_bases.MouseEvent

    See also  format_cursor_data
matplotlib.artist.Artist.get_figure   Artist.get_figure()[source]
 
Return the Figure instance the artist belongs to.
matplotlib.artist.Artist.get_gid   Artist.get_gid()[source]
 
Return the group id.
matplotlib.artist.Artist.get_in_layout   Artist.get_in_layout()[source]
 
Return boolean flag, True if artist is included in layout calculations. E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').
matplotlib.artist.Artist.get_label   Artist.get_label()[source]
 
Return the label used for this artist in the legend.
matplotlib.artist.Artist.get_path_effects   Artist.get_path_effects()[source]
matplotlib.artist.Artist.get_picker   Artist.get_picker()[source]
 
Return the picking behavior of the artist. The possible values are described in set_picker.  See also  
set_picker, pickable, pick
matplotlib.artist.Artist.get_rasterized   Artist.get_rasterized()[source]
 
Return whether the artist is to be rasterized.
matplotlib.artist.Artist.get_sketch_params   Artist.get_sketch_params()[source]
 
Return the sketch parameters for the artist.  Returns 
 tuple or None

A 3-tuple with the following elements:  
scale: The amplitude of the wiggle perpendicular to the source line. 
length: The length of the wiggle along the line. 
randomness: The scale factor by which the length is shrunken or expanded.  Returns None if no sketch parameters were set.
matplotlib.artist.Artist.get_snap   Artist.get_snap()[source]
 
Return the snap setting. See set_snap for details.
matplotlib.artist.Artist.get_transform   Artist.get_transform()[source]
 
Return the Transform instance used by this artist.
matplotlib.artist.Artist.get_transformed_clip_path_and_affine   Artist.get_transformed_clip_path_and_affine()[source]
 
Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.
matplotlib.artist.Artist.get_url   Artist.get_url()[source]
 
Return the url.
matplotlib.artist.Artist.get_visible   Artist.get_visible()[source]
 
Return the visibility.
matplotlib.artist.Artist.get_window_extent   Artist.get_window_extent(renderer)[source]
 
Get the artist's bounding box in display space. The bounding box' width and height are nonnegative. Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0. Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
matplotlib.artist.Artist.get_zorder   Artist.get_zorder()[source]
 
Return the artist's zorder.
matplotlib.artist.Artist.have_units   Artist.have_units()[source]
 
Return whether units are set on any axis.
matplotlib.artist.Artist.is_transform_set   Artist.is_transform_set()[source]
 
Return whether the Artist has an explicitly set transform. This is True after set_transform has been called.
matplotlib.artist.Artist.mouseover   propertyArtist.mouseover
 
If this property is set to True, the artist will be queried for custom context information when the mouse cursor moves over it. See also get_cursor_data(), ToolCursorPosition and NavigationToolbar2.
matplotlib.artist.Artist.pchanged   Artist.pchanged()[source]
 
Call all of the registered callbacks. This function is triggered internally when a property is changed.  See also  add_callback
remove_callback
matplotlib.artist.Artist.pick   Artist.pick(mouseevent)[source]
 
Process a pick event. Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.  See also  
set_picker, get_picker, pickable
matplotlib.artist.Artist.pickable   Artist.pickable()[source]
 
Return whether the artist is pickable.  See also  
set_picker, get_picker, pick
matplotlib.artist.Artist.properties   Artist.properties()[source]
 
Return a dictionary of all the properties of the artist.
matplotlib.artist.Artist.remove   Artist.remove()[source]
 
Remove the artist from the figure if possible. The effect will not be visible until the figure is redrawn, e.g., with FigureCanvasBase.draw_idle. Call relim to update the axes limits if desired. Note: relim will not see collections even if the collection was added to the axes with autolim = True. Note: there is no support for removing the artist's legend entry.
matplotlib.artist.Artist.remove_callback   Artist.remove_callback(oid)[source]
 
Remove a callback based on its observer id.  See also  add_callback
matplotlib.artist.Artist.set   Artist.set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
 
Set multiple properties at once. Supported properties are   
Property Description   
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  
animated bool  
clip_box Bbox  
clip_on bool  
clip_path Patch or (Path, Transform) or None  
figure Figure  
gid str  
in_layout bool  
label object  
path_effects AbstractPathEffect  
picker None or bool or float or callable  
rasterized bool  
sketch_params (scale: float, length: float, randomness: float)  
snap bool or None  
transform Transform  
url str  
visible bool  
zorder float
matplotlib.artist.Artist.set_agg_filter   Artist.set_agg_filter(filter_func)[source]
 
Set the agg filter.  Parameters 
 
filter_funccallable


A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.
matplotlib.artist.Artist.set_alpha   Artist.set_alpha(alpha)[source]
 
Set the alpha value used for blending - not supported on all backends.  Parameters 
 
alphascalar or None


alpha must be within the 0-1 range, inclusive.
matplotlib.artist.Artist.set_animated   Artist.set_animated(b)[source]
 
Set whether the artist is intended to be used in an animation. If True, the artist is excluded from regular drawing of the figure. You have to call Figure.draw_artist / Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting. See also matplotlib.animation and Faster rendering by using blitting.  Parameters 
 
bbool
matplotlib.artist.Artist.set_clip_box   Artist.set_clip_box(clipbox)[source]
 
Set the artist's clip Bbox.  Parameters 
 
clipboxBbox
matplotlib.artist.Artist.set_clip_on   Artist.set_clip_on(b)[source]
 
Set whether the artist uses clipping. When False artists will be visible outside of the axes which can lead to unexpected results.  Parameters 
 
bbool
matplotlib.artist.Artist.set_clip_path   Artist.set_clip_path(path, transform=None)[source]
 
Set the artist's clip path.  Parameters 
 
pathPatch or Path or TransformedPath or None


The clip path. If given a Path, transform must be provided as well. If None, a previously set clip path is removed.  
transformTransform, optional


Only used if path is a Path, in which case the given Path is converted to a TransformedPath using transform.     Notes For efficiency, if path is a Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None. For technical reasons (support of set), a tuple (path, transform) is also accepted as a single positional parameter.
matplotlib.artist.Artist.set_figure   Artist.set_figure(fig)[source]
 
Set the Figure instance the artist belongs to.  Parameters 
 
figFigure
matplotlib.artist.Artist.set_gid   Artist.set_gid(gid)[source]
 
Set the (group) id for the artist.  Parameters 
 
gidstr
matplotlib.artist.Artist.set_in_layout   Artist.set_in_layout(in_layout)[source]
 
Set if artist is to be included in layout calculations, E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').  Parameters 
 
in_layoutbool
matplotlib.artist.Artist.set_label   Artist.set_label(s)[source]
 
Set a label that will be displayed in the legend.  Parameters 
 
sobject


s will be converted to a string by calling str.
matplotlib.artist.Artist.set_path_effects   Artist.set_path_effects(path_effects)[source]
 
Set the path effects.  Parameters 
 
path_effectsAbstractPathEffect
matplotlib.artist.Artist.set_picker   Artist.set_picker(picker)[source]
 
Define the picking behavior of the artist.  Parameters 
 
pickerNone or bool or float or callable


This can be one of the following:  
None: Picking is disabled for this artist (default). A boolean: If True then picking will be enabled and the artist will fire a pick event if the mouse event is over the artist. A float: If picker is a number it is interpreted as an epsilon tolerance in points and the artist will fire off an event if its data is within epsilon of the mouse event. For some artists like lines and patch collections, the artist may provide additional data to the pick event that is generated, e.g., the indices of the data within epsilon of the pick event 
A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event: hit, props = picker(artist, mouseevent)
 to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.