ironflow.model package

Submodules

• ironflow.model.dtypes module
  • Boolean
  • Choice
  • DType
    • DType.accepts()
    • DType.from_str()
    • DType.valid_val()
  • Data
  • Float
  • Integer
  • List
  • String
  • Untyped
  • isiterable()
  • other_classes_are_subset()
• ironflow.model.flow module
  • Flow
    • Flow.batched_or_nothing()
    • Flow.check_connection_validity()
• ironflow.model.model module
  • HasSession
    • HasSession.active_script_index
    • HasSession.clear_recommended_nodes()
    • HasSession.create_script()
    • HasSession.delete_script()
    • HasSession.flow
    • HasSession.load()
    • HasSession.load_from_data()
    • HasSession.n_scripts
    • HasSession.next_auto_script_name
    • HasSession.recommend_nodes()
    • HasSession.register_node()
    • HasSession.register_nodes()
    • HasSession.register_nodes_from_file()
    • HasSession.register_nodes_from_module()
    • HasSession.rename_script()
    • HasSession.save()
    • HasSession.script
    • HasSession.serialize()
    • HasSession.session
• ironflow.model.node module
  • BatchingNode
    • BatchingNode.batch_lengths
    • BatchingNode.batched
    • BatchingNode.batched_inputs
    • BatchingNode.batched_representation()
    • BatchingNode.clear_output()
    • BatchingNode.generate_batched_output()
    • BatchingNode.generate_output()
    • BatchingNode.generate_unbatched_output()
    • BatchingNode.node_function()
    • BatchingNode.set_output()
    • BatchingNode.unbatched_inputs
  • DataNode
    • DataNode.place_event()
    • DataNode.update_event()
  • JobMaker
    • JobMaker.init_inputs
  • JobNode
    • JobNode.color
    • JobNode.init_inputs
    • JobNode.init_outputs
    • JobNode.node_function()
    • JobNode.place_event()
    • JobNode.update()
    • JobNode.update_event()
    • JobNode.valid_job_classes
  • JobTaker
    • JobTaker.init_inputs
    • JobTaker.inputs
    • JobTaker.outputs
    • JobTaker.place_event()
  • Node
    • Node.all_input_is_valid
    • Node.color
    • Node.create_input()
    • Node.create_input_dt()
    • Node.create_output()
    • Node.extra_representations
    • Node.main_widget_class
    • Node.output()
    • Node.place_event()
    • Node.representations
    • Node.set_all_outputs_to_none()
    • Node.setup_ports()
    • Node.update()
  • PlaceholderWidgetsContainer
  • PortFinder
  • PortList
    • PortList.labels
    • PortList.ports
    • PortList.values
  • ValueFinder
• ironflow.model.otypes module
  • OTypeLoader
    • OTypeLoader.atomistics()
  • otype_from_str()
• ironflow.model.port module
  • HasDType
    • HasDType.dtype_ok
    • HasDType.set_dtype_ok()
  • HasOType
    • HasOType.get_downstream_requirements()
    • HasOType.otype_ok
    • HasOType.recalculate_otype_checks()
    • HasOType.set_otype_ok()
  • HasTypes
    • HasTypes.ready
  • NodeInput
    • NodeInput.batch()
    • NodeInput.connected()
    • NodeInput.data()
    • NodeInput.disconnected()
    • NodeInput.unbatch()
    • NodeInput.update()
    • NodeInput.workflow_tree_contains_connections_of()
  • NodeInputBP
  • NodeOutput
    • NodeOutput.all_connections_found_in()
    • NodeOutput.data()
    • NodeOutput.disconnected()
    • NodeOutput.set_val()
  • NodeOutputBP
• ironflow.model.script module
  • Script
• ironflow.model.session module
  • Session
    • Session.create_script()

Module contents

Wrappers and extensions of the underlying ryven model.

The model.HasSession class provides the main interface between ironflow and ryven. The rest of these modules revolve mostly around the DType class – namely, ensuring that each port has a dtype attribute (None values are handled fine to describe un-typed ports) and that these dtypes can be used for meaningful type checking when making connections.