job-shop-lib 1.0.0a5__py3-none-any.whl → 1.0.0b2__py3-none-any.whl

job_shop_lib/visualization/_plot_agent_task_graph.py

@@ -1,276 +0,0 @@
-"""Contains functions to plot the agent-task graph of a job shop instance.
-
-The agent-task graph was introduced by Junyoung Park et al. (2021).
-In contrast to the disjunctive graph, instead of connecting operations that
-share the same resources directly by disjunctive edges, operation nodes are
-connected with machine ones. All machine nodes are connected between them, and
-all operation nodes from the same job are connected by non-directed edges too.
-
-See: job_shop_lib.graphs.build_agent_task_graph module for more information.
-"""
-
-from typing import Optional
-
-import matplotlib.pyplot as plt
-import networkx as nx
-
-from job_shop_lib.graphs import NodeType, JobShopGraph, Node
-
-
-def plot_agent_task_graph(
-    job_shop_graph: JobShopGraph,
-    title: Optional[str] = None,
-    figsize: tuple[int, int] = (10, 10),
-    layout: Optional[dict[Node, tuple[float, float]]] = None,
-    color_map_name: str = "tab10",
-    node_size: int = 1000,
-    alpha: float = 0.95,
-    add_legend: bool = False,
-) -> plt.Figure:
-    """Returns a plot of the agent-task graph of the instance.
-
-    Machine and job nodes are represented by squares, and the operation nodes
-    are represented by circles.
-
-    Args:
-        job_shop_graph:
-            The job shop graph instance. It should be already initialized with
-            the instance with a valid agent-task graph representation.
-
-    Returns:
-        The figure of the plot. This figure can be used to save the plot to a
-        file or to show it in a Jupyter notebook.
-    """
-    if title is None:
-        title = (
-            f"Agent-Task Graph Visualization: {job_shop_graph.instance.name}"
-        )
-    # Create a new figure and axis
-    fig, ax = plt.subplots(figsize=figsize)
-    fig.suptitle(title)
-
-    # Create the networkx graph
-    graph = job_shop_graph.graph
-    nodes = job_shop_graph.non_removed_nodes()
-
-    # Create the layout if it was not provided
-    if layout is None:
-        layout = three_columns_layout(job_shop_graph)
-
-    # Define colors and shapes
-    color_map = plt.get_cmap(color_map_name)
-    machine_colors = {
-        machine.machine_id: color_map(i)
-        for i, machine in enumerate(
-            job_shop_graph.nodes_by_type[NodeType.MACHINE]
-        )
-    }
-
-    node_colors = [
-        _get_node_color(node, machine_colors) for node in job_shop_graph.nodes
-    ]  # We need to get the color of all nodes to avoid an index error
-    node_shapes = {"machine": "s", "job": "d", "operation": "o", "global": "o"}
-
-    # Draw nodes with different shapes based on their type
-    for node_type, shape in node_shapes.items():
-        current_nodes = [
-            node.node_id
-            for node in nodes
-            if node.node_type.name.lower() == node_type
-        ]
-        nx.draw_networkx_nodes(
-            graph,
-            layout,
-            nodelist=current_nodes,
-            node_color=[node_colors[i] for i in current_nodes],
-            node_shape=shape,
-            ax=ax,
-            node_size=node_size,
-            alpha=alpha,
-        )
-
-    # Draw edges
-    nx.draw_networkx_edges(graph, layout, ax=ax)
-
-    node_labels = {node.node_id: _get_node_label(node) for node in nodes}
-    nx.draw_networkx_labels(graph, layout, node_labels, ax=ax)
-
-    ax.set_axis_off()
-
-    plt.tight_layout()
-
-    # Add to the legend the meaning of m and d
-    if add_legend:
-        plt.figtext(0, 0.95, "d = duration", wrap=True, fontsize=12)
-    return fig
-
-
-def _get_node_color(
-    node: Node, machine_colors: dict[int, tuple[float, float, float, float]]
-) -> tuple[float, float, float, float] | str:
-    if node.node_type == NodeType.OPERATION:
-        return machine_colors[node.operation.machine_id]
-    if node.node_type == NodeType.MACHINE:
-        return machine_colors[node.machine_id]
-
-    return "lightblue"
-
-
-def _get_node_label(node: Node) -> str:
-    if node.node_type == NodeType.OPERATION:
-        return f"d={node.operation.duration}"
-    if node.node_type == NodeType.MACHINE:
-        return f"M{node.machine_id}"
-    if node.node_type == NodeType.JOB:
-        return f"J{node.job_id}"
-    if node.node_type == NodeType.GLOBAL:
-        return "G"
-
-    raise ValueError(f"Invalid node type: {node.node_type}")
-
-
-def three_columns_layout(
-    job_shop_graph: JobShopGraph,
-    *,
-    leftmost_position: float = 0.1,
-    rightmost_position: float = 0.9,
-    topmost_position: float = 1.0,
-    bottommost_position: float = 0.0,
-) -> dict[Node, tuple[float, float]]:
-    """Returns the layout of the agent-task graph.
-
-    The layout is organized in a grid manner. For example, for a JobShopGraph
-    representing a job shop instance with 2 machines and 3 jobs, the layout
-    would be:
-
-    0:  -       O_11      -
-    1:  -       O_12      J1
-    2:  -       O_13      -
-    3:  M1      O_21      -
-    4:  -       O_22      J2
-    5:  -       O_23      -
-    6:  M2      O_31      -
-    7:  -       O_32      J3
-    8:  -       O_33      -
-    9:  -        -        -
-    10: -        G        -
-    Where M1 and M2 are the machine nodes, J1, J2, and J3 are the job
-    nodes, O_ij are the operation nodes, and G is the global node.
-
-    Args:
-        job_shop_graph:
-            The job shop graph instance. It should be already initialized with
-            the instance with a valid agent-task graph representation.
-        leftmost_position:
-            The center position of the leftmost column of the layout. It should
-            be a float between 0 and 1. The default is 0.1.
-        rightmost_position:
-            The center position of the rightmost column of the layout. It
-            should be a float between 0 and 1. The default is 0.9.
-        topmost_position:
-            The center position of the topmost node of the layout. It should be
-            a float between 0 and 1. The default is 0.9.
-        bottommost_position:
-            The center position of the bottommost node of the layout. It should
-            be a float between 0 and 1. The default is 0.1.
-
-    Returns:
-        A dictionary with the position of each node in the graph. The keys are
-        the node ids, and the values are tuples with the x and y coordinates.
-    """
-
-    x_positions = _get_x_positions(leftmost_position, rightmost_position)
-
-    operation_nodes = [
-        node
-        for node in job_shop_graph.nodes_by_type[NodeType.OPERATION]
-        if not job_shop_graph.is_removed(node)
-    ]
-    machine_nodes = [
-        node
-        for node in job_shop_graph.nodes_by_type[NodeType.MACHINE]
-        if not job_shop_graph.is_removed(node)
-    ]
-    job_nodes = [
-        node
-        for node in job_shop_graph.nodes_by_type[NodeType.JOB]
-        if not job_shop_graph.is_removed(node)
-    ]
-    global_nodes = [
-        node
-        for node in job_shop_graph.nodes_by_type[NodeType.GLOBAL]
-        if not job_shop_graph.is_removed(node)
-    ]
-
-    # job_nodes = job_shop_graph.nodes_by_type[NodeType.JOB]
-    # global_nodes = job_shop_graph.nodes_by_type[NodeType.GLOBAL]
-
-    total_positions = len(operation_nodes) + len(global_nodes) * 2
-    y_spacing = (topmost_position - bottommost_position) / total_positions
-
-    layout: dict[Node, tuple[float, float]] = {}
-
-    machines_spacing_multiplier = len(operation_nodes) // len(machine_nodes)
-    layout.update(
-        _assign_positions_from_top(
-            machine_nodes,
-            x_positions["machine"],
-            topmost_position,
-            y_spacing * machines_spacing_multiplier,
-        )
-    )
-    layout.update(
-        (
-            _assign_positions_from_top(
-                operation_nodes,
-                x_positions["operation"],
-                topmost_position,
-                y_spacing,
-            )
-        )
-    )
-
-    if global_nodes:
-        layout[global_nodes[0]] = (
-            x_positions["operation"],
-            bottommost_position,
-        )
-
-    if job_nodes:
-        job_multiplier = len(operation_nodes) // len(job_nodes)
-        layout.update(
-            _assign_positions_from_top(
-                job_nodes,
-                x_positions["job"],
-                topmost_position,
-                y_spacing * job_multiplier,
-            )
-        )
-    return layout
-
-
-def _get_x_positions(
-    leftmost_position: float, rightmost_position: float
-) -> dict[str, float]:
-    center_position = (
-        leftmost_position + (rightmost_position - leftmost_position) / 2
-    )
-    return {
-        "machine": leftmost_position,
-        "operation": center_position,
-        "job": rightmost_position,
-    }
-
-
-def _assign_positions_from_top(
-    nodes: list[Node],
-    x: float,
-    top: float,
-    y_spacing: float,
-) -> dict[Node, tuple[float, float]]:
-    layout: dict[Node, tuple[float, float]] = {}
-    for i, node in enumerate(nodes):
-        y = top - (i + 1) * y_spacing
-        layout[node] = (x, y)
-
-    return layout

job_shop_lib-1.0.0a5.dist-info/RECORD

@@ -1,66 +0,0 @@
-job_shop_lib/__init__.py,sha256=727ReBd86kZgmAYA8lkYhDRaAnqJ6iH6uBP-zIRbjw4,643
-job_shop_lib/_base_solver.py,sha256=p17XmtufNc9Y481cqZUT45pEkUmmW1HWG53dfhIBJH8,1363
-job_shop_lib/_job_shop_instance.py,sha256=OoKkZRQK6kbk0zgiXc-0mFk8t7aFpWK2Cah-vmI60AY,18321
-job_shop_lib/_operation.py,sha256=6YgAuqFQgvoGIYTkdsBh-b8mVlc0i9AIw8cqmiTXeHE,3809
-job_shop_lib/_schedule.py,sha256=QQ7orbpd00pTjJvsh8bNuRSEFJLst8B8GaCSB8JPXTY,11251
-job_shop_lib/_scheduled_operation.py,sha256=krjGn47VwsC7bXUTqlUq8Y-DpiSE9q2z8bqwgJVpAZo,2697
-job_shop_lib/benchmarking/__init__.py,sha256=BYCrJUNr_uk2c0xIbDt07OnUMhQx8Dudkukx3TFWxgw,3271
-job_shop_lib/benchmarking/_load_benchmark.py,sha256=-cgyx0Kn6uAc3KdGFSQb6eUVQjQggmpVKOH9qusNkXI,2930
-job_shop_lib/benchmarking/benchmark_instances.json,sha256=F9EvyzFwVxiKAN6rQTsrMhsKstmyUmroyWduM7a00KQ,464841
-job_shop_lib/constraint_programming/__init__.py,sha256=kKQRUxxS_nVFUdXGnf4bQOD9mqrXxZZWElS753A4YiA,454
-job_shop_lib/constraint_programming/_ortools_solver.py,sha256=oMPeA2VHoYX1ZvmygQ8kYew40ITLAQATmM4OhgVFuXM,10482
-job_shop_lib/dispatching/__init__.py,sha256=2VQYWNSyuDx3zzrDPCEzs5VJd2AIJvF7vA7LwK5z2V4,1648
-job_shop_lib/dispatching/_dispatcher.py,sha256=uy4_EHdhwhGLWc1zv1AtY9FApP-70AdjCnLa3_q2nOQ,22316
-job_shop_lib/dispatching/_dispatcher_observer_config.py,sha256=034m83TsZXAb89nPxGRZm--0KSaGA9tJnr-7aYQs6tU,2479
-job_shop_lib/dispatching/_factories.py,sha256=D9m_tHUqQe-aGc50X_5HSm27nELwm4VyVEg6zUudkyg,4643
-job_shop_lib/dispatching/_history_observer.py,sha256=Vl8rQaxekUeEB-AyNxyC3c76zQakeh-rdri2iDnZvXw,610
-job_shop_lib/dispatching/_ready_operation_filters.py,sha256=Mywt57h8Nlj6XrptWakVt9n1Tq4jsneZFQEgjLMxJgw,5731
-job_shop_lib/dispatching/_unscheduled_operations_observer.py,sha256=LNEzqOWqEf6fvtkQrDmDWFEhCfA75OgEtzdomzbxYII,2683
-job_shop_lib/dispatching/feature_observers/__init__.py,sha256=EuJLvSpJpoXUK8A4UuC2k6Mpa293ZR3oCnnvYivIBtU,2240
-job_shop_lib/dispatching/feature_observers/_composite_feature_observer.py,sha256=HnvNQTXvCX5HAqBdYqzY-cPjeP0VcUxP6OTXvIlMulk,7876
-job_shop_lib/dispatching/feature_observers/_duration_observer.py,sha256=fbkUIVScF1iNjdVCYr1ImQm53TfahvVnGXhsRAsgdzY,4129
-job_shop_lib/dispatching/feature_observers/_earliest_start_time_observer.py,sha256=SOdXs-uzTzcLqOsmpbKvf-OGlGXOMVVJL9zgVVVDvF8,11442
-job_shop_lib/dispatching/feature_observers/_factory.py,sha256=PLbpiJDPQRcicxyrIaBeyWnJRPlMVLJixzB44C0SXYE,3171
-job_shop_lib/dispatching/feature_observers/_feature_observer.py,sha256=crbqG1KrmUOfG4z7shHNzhUg7-uSP4_RWxyOi-RRWmE,8635
-job_shop_lib/dispatching/feature_observers/_is_completed_observer.py,sha256=wG84zhmIWEXZjgT883Vz-onJZYpB7SJb2FsznEbkPQw,4592
-job_shop_lib/dispatching/feature_observers/_is_ready_observer.py,sha256=wy_pA-1wmnzVjhq92mdsT2JJHYbfsm79mcMgSgYUCOs,1264
-job_shop_lib/dispatching/feature_observers/_is_scheduled_observer.py,sha256=OcuMUB9_By6ZMtX-1_3z-xaxGbP85a5Zv0ywAv7XxWQ,1491
-job_shop_lib/dispatching/feature_observers/_position_in_job_observer.py,sha256=WRknpQBKXs6h6cXLFJW7ZCvjtU8CPL-iXXNPw3g-mLE,1303
-job_shop_lib/dispatching/feature_observers/_remaining_operations_observer.py,sha256=5V87lCrJUabEe8AkTGXPu5yS8OGxeN8L3-xNyHmdmLs,1441
-job_shop_lib/dispatching/rules/__init__.py,sha256=p1rkqf66L62uvAOM1ZxNV8xHoh7SuYjHi_8ZNBvPIjg,1450
-job_shop_lib/dispatching/rules/_dispatching_rule_factory.py,sha256=5fNpv90fAoR6rcE6NeJOWiB7ir-FVnoONIhHtKJ9H0E,2904
-job_shop_lib/dispatching/rules/_dispatching_rule_solver.py,sha256=goO3wl5NY9mjRr6d3KBaImA7gpseFDawdZdRhkIM5bM,6349
-job_shop_lib/dispatching/rules/_dispatching_rules_functions.py,sha256=yRJXYH6QSxDCIK8vqNUfMCMpzWmr3j_camAR72Z6D9Q,7605
-job_shop_lib/dispatching/rules/_machine_chooser_factory.py,sha256=xsJ8nJwPDBi-sfLJRQF_BBQDbyXDfopD1U-efXffQAE,2331
-job_shop_lib/dispatching/rules/_utils.py,sha256=X8vET2p1D3RyoB9mFfsfRgmilcTmxPssKYyJQ2zEt0Q,4605
-job_shop_lib/exceptions.py,sha256=ARzpoZJCvRIvOesCiqqFSRxkv6w9WwEXx0aBP-l2IKA,1597
-job_shop_lib/generation/__init__.py,sha256=hUqjnE0bEoknuUwFoLUWjBH26qTTCGsJAW4gscAbiQ8,294
-job_shop_lib/generation/_general_instance_generator.py,sha256=uqSYzP6vW1SgmaRrTP1svjq-nPQXNJeXcKVW6gp9sdI,7318
-job_shop_lib/generation/_instance_generator.py,sha256=e_A7lSV5IMG2vPeANp50S5bg19XrhiQ9rvzOP-US1l0,4504
-job_shop_lib/generation/_transformations.py,sha256=ZigQTBsS3xgB2FhBu9MpsFs7A-_VY3840V_RtOIhCBk,5296
-job_shop_lib/graphs/__init__.py,sha256=GEtrWjbeFEFpvNytlvqEU6ZUPZP7qX-71N659f9r2u8,1818
-job_shop_lib/graphs/_build_agent_task_graph.py,sha256=6mvWJ7fFD5CmxkTuXEwY7f_-qxjKdNgFmWk4a4mgiD8,7132
-job_shop_lib/graphs/_build_disjunctive_graph.py,sha256=UbUYdeQaaeEqLchcKJGHEFGl4wElfGLb1o_R-u8wqnA,5120
-job_shop_lib/graphs/_constants.py,sha256=K-GeVvh_DTWpo1KOX1clmxWS_pkUJbq19yOBmrCVIxI,1086
-job_shop_lib/graphs/_job_shop_graph.py,sha256=Fv0TOwtmjqdhH-A_TBH0wSzQkGgqTyc7vvEcfzbQiwA,10681
-job_shop_lib/graphs/_node.py,sha256=hGgdnD9wlsTbkaDizFZMsxPXa2-m91iBNLu0vtkVbxw,6034
-job_shop_lib/graphs/graph_updaters/__init__.py,sha256=UhnZL55e3cAv7hVetB6bRmIOn8BDhG2bsbrdRoHtxLY,516
-job_shop_lib/graphs/graph_updaters/_graph_updater.py,sha256=j1f7iWsa62GVszK2BPaMxnKBCEGWa9owm8g4VWUje8w,1967
-job_shop_lib/graphs/graph_updaters/_residual_graph_updater.py,sha256=Sli9YpbtKlAvjEQxbc6gS1kOZneBD7RPqm_DagtJFe4,6009
-job_shop_lib/graphs/graph_updaters/_utils.py,sha256=X5YfwJA1CCgpm1r9C036Gal2CkDh2SSak7wl7TbdjHw,704
-job_shop_lib/reinforcement_learning/__init__.py,sha256=gOY-C6BMeFr3084MKMMbW0CoK7gMsaOYNsgnYuepswQ,1033
-job_shop_lib/reinforcement_learning/_multi_job_shop_graph_env.py,sha256=N28SslcKBguhILQxisc7NIuR3XVnMrj1dzBSEKA8AdE,14865
-job_shop_lib/reinforcement_learning/_reward_observers.py,sha256=4Kdyn9Jlp_1sBtVr6raF-ZFtcnKxwyCLykfX53TmuhU,2959
-job_shop_lib/reinforcement_learning/_single_job_shop_graph_env.py,sha256=_qZ69kvgpBUoRJDL0SYDxj3Lq6_8HT3MDaxJndqgon0,12970
-job_shop_lib/reinforcement_learning/_types_and_constants.py,sha256=5lvjXihMrj2ziLlquLXQxtwzjLM5yo7Ny8kPo-aCmlQ,1737
-job_shop_lib/reinforcement_learning/_utils.py,sha256=ilI089Bs8CRlfRV_yH6XH8oypTDtRa7hS-H4iRCC5lU,2497
-job_shop_lib/visualization/__init__.py,sha256=K85MQdAbsguvoH99NX9sxZP458jDXSljpzQiS_4-dlU,1587
-job_shop_lib/visualization/_gantt_chart_creator.py,sha256=p7W7OaLoHO5xdlNaJXQVBweszb2bNuM6oP9TAhNgwss,8600
-job_shop_lib/visualization/_gantt_chart_video_and_gif_creation.py,sha256=aPy7y0oZlEQUzoYQnagiRi_2C-80WY29HR2KpekS6wQ,14384
-job_shop_lib/visualization/_plot_agent_task_graph.py,sha256=AaBTD_S34WjrsZnL_iMAplR_f67RahZi7x58SOvp-q0,8834
-job_shop_lib/visualization/_plot_disjunctive_graph.py,sha256=Vo3c2oHQ8YkLbwrDr76zh4yzCuQk-gkVeyWN-7Zj71o,14279
-job_shop_lib/visualization/_plot_gantt_chart.py,sha256=1WCJ5Gjl3dwA-w4Jn9suIg-ZGR28yYUAy8Jp-IiyvfI,6842
-job_shop_lib-1.0.0a5.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
-job_shop_lib-1.0.0a5.dist-info/METADATA,sha256=R-7tM_SWNJV6JoTtDh_FlO6SbD-fXQt36Ro0KZAzLKk,16184
-job_shop_lib-1.0.0a5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-job_shop_lib-1.0.0a5.dist-info/RECORD,,