module graphhelper.magic_graph

Short summary

module pyensae.graphhelper.magic_graph

Magic commands about graphs

Classes

class	truncated documentation
MagicGraph	Defines magic commands about graphs

Functions

function	truncated documentation
register_graph_magics	register magics function, can be called from a notebook

Properties

property	truncated documentation
Context	return the context or None
cross_validation_lock	A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

Static Methods

staticmethod	truncated documentation
mpl_style_parser	defines the way to parse the magic command %mpl_style

Methods

method	truncated documentation
mpl_style	defines %mpl_style which changes the style of matplotlib graphs, example: %mpl_style ggplot

Documentation

Magic commands about graphs

New in version 1.1.

source on GitHub

class pyensae.graphhelper.magic_graph.MagicGraph(**kwargs: Any)

Bases: MagicClassWithHelpers

Defines magic commands about graphs

New in version 1.1.

source on GitHub

Create a configurable given a config config.

Parameters

configConfig

If this is empty, default values are used. If config is a Config instance, it will be used to configure the instance.

parentConfigurable instance, optional

The parent Configurable instance of this object.

Notes

Subclasses of Configurable must call the __init__() method of Configurable before doing anything else and using super():

class MyConfigurable(Configurable):
    def __init__(self, config=None):
        super(MyConfigurable, self).__init__(config=config)
        # Then any other code you need to finish initialization.

This ensures that instances will be configured properly.

_all_trait_default_generators: Dict[str, Any] = {'config': <bound method TraitType.default of <traitlets.traitlets.Instance object>>, 'parent': <bound method TraitType.default of <traitlets.traitlets.Instance object>>}

_cross_validation_lock: bool

_descriptors = [<traitlets.traitlets.ObserveHandler object>, <traitlets.traitlets.Instance object>, <traitlets.traitlets.Instance object>]

_instance_inits = [<bound method ObserveHandler.instance_init of <traitlets.traitlets.ObserveHandler object>>, <bound method Instance.instance_init of <traitlets.traitlets.Instance object>>, <bound method Instance.instance_init of <traitlets.traitlets.Instance object>>]

_static_immutable_initial_values: Dict[str, Any] = {'parent': None}

_trait_default_generators = {}

_trait_notifiers: Dict[str, Any]

_trait_validators: Dict[str, Any]

_trait_values: Dict[str, Any]

_traits: Dict[str, Any] = {'config': <traitlets.traitlets.Instance object>, 'parent': <traitlets.traitlets.Instance object>}

mpl_style(line)

defines %mpl_style which changes the style of matplotlib graphs, example: %mpl_style ggplot

mpl_style

This magic just does:

import matplotlib.pyplot as plt
plt.style.use('ggplot')

It should take place at the beginning of the notebook.

source on GitHub

static mpl_style_parser()

defines the way to parse the magic command %mpl_style

source on GitHub

pyensae.graphhelper.magic_graph.register_graph_magics(ip=None)

register magics function, can be called from a notebook

Parameters:

ip – from get_ipython()

source on GitHub