Drop the older # Requirements: parser

Superseded by the `required` flag on DIVE_PARAM (see PR #1639). VIAME
\`.pipe\` files using the old `# Requirements:` header should be
migrated to the new spec — until they are, those parameters won't be
prompted for.

- Drop \`PipelineRequirement\` from apispec.ts and dive_utils/types.py.
- Drop \`description\` and \`requirements\` fields from \`Pipe\` /
  \`PipelineDescription\`; description is already exposed via
  \`metadata.description\`.
- Drop \`extract_pipe_description\`, \`extract_pipe_requirements\`,
  \`extractPipeDescription\`, \`extractPipeRequirements\`. Training
  config descriptions now read from \`extractPipeMetadata().description\`.
- Drop the Requirements dialog from RunPipelineMenu.

Author: mattdawkins

client/dive-common/apispec.ts

@@ -36,15 +36,6 @@ interface AnnotationSchemaList {
   sets: string[];
 }
 
-interface PipelineRequirement {
-  /** Display name shown in the GUI */
-  title: string;
-  /** KWIVER -s override key (e.g. "track_refiner:refiner:sam3:text_query") */
-  kwiver_override: string;
-  /** Parameter type: string, int, float, bool */
-  param_type: string;
-}
-
 interface DiveParam {
   label: string;
   type: PipelineParamType;
@@ -64,8 +55,6 @@ interface Pipe {
   name: string;
   pipe: string;
   type: string;
-  description?: string;
-  requirements?: PipelineRequirement[];
   metadata?: PipeMetadata;
   folderId?: string;
   ownerId?: string;
@@ -393,7 +382,6 @@ export {
   MultiTrackRecord,
   MultiGroupRecord,
   Pipe,
-  PipelineRequirement,
   PipeMetadata,
   Pipelines,
   SaveDetectionsArgs,

client/dive-common/components/RunPipelineMenu.vue

@@ -10,7 +10,6 @@ import {
 import {
   Pipelines,
   Pipe,
-  PipelineRequirement,
   useApi,
   SubType,
   DatasetType,
@@ -102,48 +101,6 @@ export default defineComponent({
       menuState.value = 'idle';
     }
 
-    // Requirements dialog state (VIAME-specific)
-    const requirementsDialogOpen = ref(false);
-    const requirementsPipeline: Ref<Pipe | null> = ref(null);
-    const requirementValues: Ref<Record<string, string>> = ref({});
-
-    function openRequirementsDialog(pipeline: Pipe) {
-      requirementsPipeline.value = pipeline;
-      const values: Record<string, string> = {};
-      (pipeline.requirements || []).forEach((req: PipelineRequirement) => {
-        if (req.param_type === 'bool') {
-          values[req.kwiver_override] = 'false';
-        } else if (req.param_type === 'int' || req.param_type === 'float') {
-          values[req.kwiver_override] = '0';
-        } else {
-          values[req.kwiver_override] = '';
-        }
-      });
-      requirementValues.value = values;
-      requirementsDialogOpen.value = true;
-    }
-
-    function cancelRequirements() {
-      requirementsDialogOpen.value = false;
-      requirementsPipeline.value = null;
-      requirementValues.value = {};
-    }
-
-    async function submitRequirements() {
-      if (!requirementsPipeline.value) return;
-      requirementsDialogOpen.value = false;
-      const pipeline = requirementsPipeline.value;
-      const additionalConfig: Record<string, string> = { ...requirementValues.value };
-      requirementsPipeline.value = null;
-      requirementValues.value = {};
-      const configById: Record<string, Record<string, string>> = {};
-      props.selectedDatasetIds.forEach((id) => {
-        configById[id] = additionalConfig;
-      });
-      _runPipelineOnSelectedItemInner(pipeline, configById);
-    }
-
-    // DiveParams dialog state (origin/main)
     const showParamsDialog = ref(false);
     const pipelineParams = ref<Record<string, string>>({});
 
@@ -259,10 +216,6 @@ export default defineComponent({
     }
 
     async function runPipelineOnSelectedItem(pipeline: Pipe) {
-      if (pipeline.requirements && pipeline.requirements.length > 0) {
-        openRequirementsDialog(pipeline);
-        return;
-      }
       if (pipeline.metadata?.diveParams && pipeline.metadata?.diveParams?.length > 0) {
         openDiveParamsDialog(pipeline);
         return;
@@ -330,11 +283,6 @@ export default defineComponent({
       cancelConfig,
       menuState,
       exitPipelineConfig,
-      requirementsDialogOpen,
-      requirementsPipeline,
-      requirementValues,
-      cancelRequirements,
-      submitRequirements,
       pipelineParams,
       showParamsDialog,
       confirmPipelineExecution,
@@ -490,7 +438,7 @@ export default defineComponent({
                         <v-list-item-title class="font-weight-regular" style="display: flex; justify-content: space-between; align-items: center;">
                           {{ pipeline.name }}
                           <v-icon style="margin-left: 20px">
-                            {{ (pipeline.metadata?.diveParams?.length ?? 0) > 0 || (pipeline.requirements?.length ?? 0) > 0 ? 'mdi-application-cog-outline' : 'mdi-play-outline' }}
+                            {{ (pipeline.metadata?.diveParams?.length ?? 0) > 0 ? 'mdi-application-cog-outline' : 'mdi-play-outline' }}
                           </v-icon>
                         </v-list-item-title>
                       </v-list-item>
@@ -519,84 +467,6 @@ export default defineComponent({
       @cancel="cancelConfig"
       @submit="exitPipelineConfig"
     />
-    <!-- Requirements Dialog -->
-    <v-dialog
-      :value="requirementsDialogOpen"
-      max-width="500"
-      persistent
-    >
-      <v-card v-if="requirementsPipeline">
-        <v-card-title class="text-h6">
-          <v-icon left>
-            mdi-cog
-          </v-icon>
-          {{ requirementsPipeline.name }}
-        </v-card-title>
-        <v-card-text>
-          <p class="text-body-2 mb-4">
-            This pipeline requires the following parameters:
-          </p>
-          <template v-for="req in requirementsPipeline.requirements">
-            <v-checkbox
-              v-if="req.param_type === 'bool'"
-              :key="req.kwiver_override"
-              v-model="requirementValues[req.kwiver_override]"
-              :label="req.title"
-              true-value="true"
-              false-value="false"
-              dense
-              class="mt-1"
-            />
-            <v-text-field
-              v-else-if="req.param_type === 'int'"
-              :key="req.kwiver_override"
-              v-model="requirementValues[req.kwiver_override]"
-              :label="req.title"
-              type="number"
-              step="1"
-              outlined
-              dense
-              class="mt-2"
-            />
-            <v-text-field
-              v-else-if="req.param_type === 'float'"
-              :key="req.kwiver_override"
-              v-model="requirementValues[req.kwiver_override]"
-              :label="req.title"
-              type="number"
-              step="0.01"
-              outlined
-              dense
-              class="mt-2"
-            />
-            <v-text-field
-              v-else
-              :key="req.kwiver_override"
-              v-model="requirementValues[req.kwiver_override]"
-              :label="req.title"
-              outlined
-              dense
-              class="mt-2"
-            />
-          </template>
-        </v-card-text>
-        <v-card-actions>
-          <v-spacer />
-          <v-btn
-            text
-            @click="cancelRequirements"
-          >
-            Cancel
-          </v-btn>
-          <v-btn
-            color="primary"
-            @click="submitRequirements"
-          >
-            Run Pipeline
-          </v-btn>
-        </v-card-actions>
-      </v-card>
-    </v-dialog>
     <PipelineParamsDialog
       v-model="showParamsDialog"
       :pipeline="selectedPipeline"

client/platform/desktop/backend/native/common.ts

@@ -23,7 +23,6 @@ import {
   AnnotationSchema,
   SaveAttributeTrackFilterArgs,
   Pipe,
-  PipelineRequirement,
   PipeMetadata,
   PipelineParamType,
 } from 'dive-common/apispec';
@@ -72,112 +71,6 @@ async function readLines(filePath: string): Promise<string[]> {
   return rawBuffer.toString().replace(/\r\n/g, '\n').split('\n');
 }
 
-/**
- * Extract description from a .pipe file header.
- * Looks for "# Description: " in the first 5 lines of the file.
- * Description can span multiple lines and ends when:
- * - A line starting with "# " followed by "=" is found (e.g., "# ===")
- * - A line starting with "#" followed by only whitespace is found
- * - A non-comment line is found
- */
-async function extractPipeDescription(filePath: string): Promise<string | undefined> {
-  try {
-    const lines = await readLines(filePath);
-    let description = '';
-    let inDescription = false;
-    let descriptionStartLine = -1;
-
-    // Find the Description: field within the first 5 lines
-    const headerLines = lines.slice(0, 5);
-    const descStartIndex = headerLines.findIndex((line) => /^#\s*Description:\s*/i.test(line));
-
-    if (descStartIndex === -1) {
-      return undefined;
-    }
-
-    // Extract the initial description text
-    const descMatch = headerLines[descStartIndex].match(/^#\s*Description:\s*(.*)$/i);
-    if (descMatch) {
-      description = descMatch[1].trim();
-      inDescription = true;
-      descriptionStartLine = descStartIndex;
-    }
-
-    // Continue reading from the line after Description: was found
-    if (inDescription) {
-      const remainingLines = lines.slice(descriptionStartLine + 1);
-      remainingLines.some((line) => {
-        // End conditions:
-        // 1. Line starting with "# " followed by "=" (e.g., "# ===")
-        if (/^#\s*=/.test(line)) {
-          return true; // stop iteration
-        }
-        // 2. Line starting with "#" followed by only whitespace
-        if (/^#\s*$/.test(line)) {
-          return true; // stop iteration
-        }
-        // 3. Non-comment line (not starting with #)
-        if (!line.startsWith('#')) {
-          return true; // stop iteration
-        }
-
-        // Continue reading multi-line description
-        const continuedText = line.replace(/^#\s*/, '').trim();
-        if (continuedText) {
-          description += ` ${continuedText}`;
-        }
-        return false; // continue iteration
-      });
-    }
-
-    return description || undefined;
-  } catch {
-    return undefined;
-  }
-}
-
-/**
- * Extract requirements from a .pipe file header.
- * Looks for "# Requirements: " lines in the first 20 lines.
- * Each requirement is specified as: { Title, kwiver_override_key, type }
- */
-async function extractPipeRequirements(
-  filePath: string,
-): Promise<PipelineRequirement[] | undefined> {
-  try {
-    const lines = await readLines(filePath);
-    const requirements: PipelineRequirement[] = [];
-
-    const headerLines = lines.slice(0, 20);
-    headerLines.forEach((line) => {
-      const match = line.match(/^#\s*Requirements?:\s*(.+)$/i);
-      if (match) {
-        const raw = match[1].trim();
-        // Support multiple requirements on same line separated by ;
-        raw.split(';').forEach((entry) => {
-          let trimmed = entry.trim();
-          // Remove surrounding braces if present
-          if (trimmed.startsWith('{') && trimmed.endsWith('}')) {
-            trimmed = trimmed.slice(1, -1).trim();
-          }
-          const parts = trimmed.split(',').map((p) => p.trim());
-          if (parts.length >= 3) {
-            requirements.push({
-              title: parts[0],
-              kwiver_override: parts[1],
-              param_type: parts[2],
-            });
-          }
-        });
-      }
-    });
-
-    return requirements.length > 0 ? requirements : undefined;
-  } catch {
-    return undefined;
-  }
-}
-
 /**
  * Extract metadata from a .pipe file header.
  */
@@ -587,18 +480,12 @@ async function getPipelineList(settings: Settings): Promise<Pipelines> {
     }
 
     const pipeFilePath = npath.join(pipelinePath, p);
-    const [description, requirements, metadata] = await Promise.all([
-      extractPipeDescription(pipeFilePath),
-      extractPipeRequirements(pipeFilePath),
-      extractPipeMetadata(pipeFilePath),
-    ]);
+    const metadata = await extractPipeMetadata(pipeFilePath);
 
     const pipeInfo: Pipe = {
       name: pipeName,
       type: pipeType,
       pipe: p,
-      description,
-      requirements,
       metadata,
     };
     if (pipeType in ret) {
@@ -698,7 +585,7 @@ async function getTrainingConfigs(settings: Settings): Promise<TrainingConfigs>
 
   const configs: TrainingConfig[] = await Promise.all(configNames.map(async (name) => {
     const configFilePath = npath.join(pipelinePath, name);
-    const description = await extractPipeDescription(configFilePath);
+    const { description } = await extractPipeMetadata(configFilePath);
     return { name, description };
   }));