How to Use Plugins in Your Project

You can run Export, Batch Model, File Explorer, and Markdown Generator plugins from the Plugins page, while model plugins can be executed through the Labeling Editor or within the Workflow.

Running Plugins from the Plugin Popup Dialog

To run a plugin from the Plugin popup dialog:

1. Navigate to Your Project > Settings > Plugins.

2. Select the plugin you want to run and click Open.

3. Configure the plugin as needed by adjusting the Plugin Settings.

4. Ensure the plugin’s status is Live to run it properly.

5. Click the Run button to run the plugin.

Plugin Popup Dialog

Running Model Plugins on the Labeling Editor

To use a model plugin within the labeling editor:

1. Go to the Labeling Editor.

2. Ensure the plugin’s preset is prepared and set as the default. For more details, visit the Plugin Configuration and Preset Management page.

3. Click the Plugin icon in the labeling editor’s toolbar.

4. Click the name of your plugin from the list and run it.

Running Model Plugins on the Labeling Editor

Running Model Plugins on the Workflow

To add a model plugin to your workflow:

1. Go to the Workflow tab.

2. Add a Plugin Stage to the workflow.

3. Connect the plugin stage to other workflow stages as needed.

4. Select your desired model plugin.

5. Load an existing preset or configure the plugin manually, including settings such as overwrite options, class mappings, and the config JSON.

6. Save the workflow.

Once configured, the plugin will automatically trigger when assets enter this stage, running the associated code for each asset. Make sure the plugin’s status is set to Live to ensure it runs correctly.

A workflow with plugin stage

If the plugin stage stops running for any reason, you can restart it using the Re-run button.