spark.graph_editor.models.nodes

spark.graph_editor.models.nodes#

Classes#

AbstractNode

Abstract node model use to represent different components of a Spark model.

SourceNode

Node representing the input to the system.

SinkNode

Node representing the output of the system.

SparkModuleNode

Abstract node representing a SparkModule.

Functions#

module_to_nodegraph(entry)

Factory function that creates a new NodeGraphQt node class from an Spark module class.

Module Contents#

class spark.graph_editor.models.nodes.AbstractNode[source]#

Bases: NodeGraphQt.BaseNode, abc.ABC

Abstract node model use to represent different components of a Spark model.

__identifier__ = 'spark'[source]#
NODE_NAME = 'Abstract Node'[source]#
input_specs: dict[str, spark.core.specs.PortSpecs][source]#
output_specs: dict[str, spark.core.specs.PortSpecs][source]#
graph: spark.graph_editor.models.graph.SparkNodeGraph[source]#
update_io_spec(spec, port_name, payload_type=None, shape=None, dtype=None, description=None)[source]#

Method to update node IO specs. Valid updates are broadcasted.

Parameters:

  • spec (str) – str, target spec {input, output}

  • port_name (str) – str, the name of the port to update

  • payload_type (type[spark.core.payloads.SparkPayload] | None) – type[SparkPayload] | None, the new payload_type

  • shape (tuple[int, Ellipsis] | None) – tuple[int, …] | None, the new shape

  • dtype (jax.typing.DTypeLike | None) – DTypeLike | None, the new dtype

  • description (str | None) – str | None, the new description

property metadata: dict[source]#
Abstractmethod:

Return type:

dict

class spark.graph_editor.models.nodes.SourceNode[source]#

Bases: AbstractNode

Node representing the input to the system.

NODE_NAME = 'Source Node'[source]#
output_specs[source]#
property metadata: dict[source]#
Return type:

dict

class spark.graph_editor.models.nodes.SinkNode[source]#

Bases: AbstractNode

Node representing the output of the system.

NODE_NAME = 'Sink Node'[source]#
input_specs[source]#
property metadata: dict[source]#
Return type:

dict

class spark.graph_editor.models.nodes.SparkModuleNode[source]#

Bases: AbstractNode, abc.ABC

Abstract node representing a SparkModule.

NODE_NAME = 'SparkModule'[source]#
module_cls: type[spark.core.module.SparkModule][source]#
node_config: spark.core.config.BaseSparkConfig[source]#
input_specs[source]#
output_specs[source]#
property metadata: dict[source]#
Return type:

dict

spark.graph_editor.models.nodes.module_to_nodegraph(entry)[source]#

Factory function that creates a new NodeGraphQt node class from an Spark module class.

Parameters:

entry (spark.core.registry.RegistryEntry)

Return type:

type[SparkModuleNode]

Contents