With the Plots Artifacts API, your Latch workflow can generate a new notebook from a standard Plot Template in your workspace and automatically populate the notebook’s input widgets from parameters outputted from the workflow.

Example: A DESeq2 workflow execution outputs a Plots Artifact on Latch Data with all the notebook parameters filled out. This eliminates the need for manual parameter entry by scientists, thereby minimizing rooms for errors.

​
Behavior

  • Using the API in workflow code creates a Plot Artifact in Latch Data. We provide a detailed usage example below.
  • Double-clicking the Artifact opens a new Plot Notebook based on the template defined in the workflow code.
  • Each Plot Notebook runs on a dedicated machine:
    • The machine is started the first time the Artifact is opened.
    • Subsequent openings of the Artifact reuse the same machine to avoid extra costs.

​
Usage

​
Step 1: Define the PlotsArtifact dataclass:

Example
from latch.types.plots import PlotsArtifactBindings, PlotsArtifactTemplate, PlotsArtifact, Widget

artifact = PlotsArtifact(
    bindings=PlotsArtifactBindings(
        plot_templates=[
            PlotsArtifactTemplate(
                template_id="1234", ## The Plot template ID
                widgets=[
                    Widget(
                        transform_id="1234", ## The Python transform ID
                        key="1", ## The `key` of the widget that we want to populate
                        value="Value" ## Value to populate that widget with
                    )
                ],
            )
        ]
    )
)

​
Step 2: Upload the dataclass to Latch Data

Next, dump the dataclass into a JSON file and upload it to Latch Data. 
from latch.types.plots import PlotsArtifactBindings, PlotsArtifactTemplate, PlotsArtifact, Widget

@small_task
def my_task(output_dir: LatchDir) -> LatchFile:
    artifact = PlotsArtifact(
        bindings=PlotsArtifactBindings(
            plot_templates=[
                PlotsArtifactTemplate(
                    template_id="46", ## The Plot template ID
                    widgets=[
                        Widget(
                            transform_id="1234", ## The Python transform ID
                            key="input_1", ## The `key` of the widget that we want to populate
                            value="petal.width" ## Value to populate that widget with
                        )
                    ],
                )
            ]
        )
    )

# Convert the dataclass to a dictionary
artifact_dict = artifact.asdict()

# Write it to a JSON file
with open("artifact.json", "w") as f:
    json.dump(artifact_dict, f, indent=2)

 # You need to return a file artifact for the workflow
return LatchFile(output_path, f"{output_dir.remote_path}/artifact.json")