Rename instance diameter parameter for instance model training (#9194)

Renames the param in UI, frontend, backend, job parameters

### Steps to test:
- With local worker, check that this parameter is correctly passed from
UI (train model page) all the way to worker

### Issues:
- fixes #9179

------
- [x] Added changelog entry (create a `$PR_NUMBER.md` file in
`unreleased_changes` or use `./tools/create-changelog-entry.py`)
- [x] Considered [common edge
cases](../blob/master/.github/common_edge_cases.md)

Author: fm3

app/controllers/AiModelController.scala

@@ -43,7 +43,7 @@ object RunNeuronModelTrainingParameters {
 case class RunInstanceModelTrainingParameters(trainingAnnotations: List[TrainingAnnotationSpecification],
                                               name: String,
                                               aiModelCategory: Option[AiModelCategory],
-                                              maxDistanceNm: Option[Double],
+                                              instanceDiameterNm: Option[Double],
                                               comment: Option[String],
                                               workflowYaml: Option[String])
 
@@ -220,7 +220,7 @@ class AiModelController @Inject()(
           "organization_id" -> organization._id,
           "model_id" -> modelId,
           "custom_workflow_provided_by_user" -> request.body.workflowYaml,
-          "max_distance_nm" -> request.body.maxDistanceNm
+          "instance_diameter_nm" -> request.body.instanceDiameterNm
         )
         existingAiModelsCount <- aiModelDAO.countByNameAndOrganization(request.body.name,
                                                                        request.identity._organization)

frontend/javascripts/admin/api/jobs.ts

@@ -375,7 +375,7 @@ type RunInstanceModelTrainingParameters = {
   trainingAnnotations: AiModelTrainingAnnotationSpecification[];
   name: string;
   aiModelCategory: APIAiModelCategory.EM_NUCLEI;
-  maxDistanceNm: number;
+  instanceDiameterNm: number;
   comment?: string;
   workflowYaml?: string;
 };

frontend/javascripts/viewer/view/ai_jobs/train_ai_model/ai_training_job_context.tsx

@@ -42,8 +42,8 @@ interface AiTrainingJobContextType {
   setModelName: (name: string) => void;
   comments: string;
   setComments: (comments: string) => void;
-  maxDistanceNm: number;
-  setMaxDistanceNm: (dist: number) => void;
+  instanceDiameterNm: number;
+  setInstanceDiameterNm: (dist: number) => void;
 
   selectedAnnotations: AiTrainingAnnotationSelection[];
   setSelectedAnnotations: React.Dispatch<React.SetStateAction<AiTrainingAnnotationSelection[]>>;
@@ -70,7 +70,7 @@ export const AiTrainingJobContextProvider: React.FC<{ children: React.ReactNode
     [],
   );
   const [comments, setComments] = useState("");
-  const [maxDistanceNm, setMaxDistanceNm] = useState(1000.0);
+  const [instanceDiameterNm, setInstanceDiameterNm] = useState(1000.0);
 
   const dispatch = useDispatch();
 
@@ -166,7 +166,7 @@ export const AiTrainingJobContextProvider: React.FC<{ children: React.ReactNode
       if (selectedJobType === APIJobCommand.TRAIN_INSTANCE_MODEL) {
         await runInstanceModelTraining({
           aiModelCategory: APIAiModelCategory.EM_NUCLEI,
-          maxDistanceNm: maxDistanceNm,
+          instanceDiameterNm: instanceDiameterNm,
           ...commonJobArgmuments,
         });
       } else {
@@ -181,7 +181,7 @@ export const AiTrainingJobContextProvider: React.FC<{ children: React.ReactNode
       console.error(error);
       Toast.error("Failed to start training.");
     }
-  }, [modelName, selectedJobType, selectedAnnotations, comments, maxDistanceNm, dispatch]);
+  }, [modelName, selectedJobType, selectedAnnotations, comments, instanceDiameterNm, dispatch]);
 
   const value = {
     selectedJobType,
@@ -193,8 +193,8 @@ export const AiTrainingJobContextProvider: React.FC<{ children: React.ReactNode
     setModelName,
     comments,
     setComments,
-    maxDistanceNm,
-    setMaxDistanceNm,
+    instanceDiameterNm,
+    setInstanceDiameterNm,
     selectedAnnotations,
     setSelectedAnnotations,
     handleSelectionChange,

frontend/javascripts/viewer/view/ai_jobs/train_ai_model/ai_training_settings.tsx

@@ -14,8 +14,8 @@ export const AiTrainingSettings: React.FC = () => {
     comments,
     setComments,
     selectedTask,
-    maxDistanceNm,
-    setMaxDistanceNm,
+    instanceDiameterNm,
+    setInstanceDiameterNm,
   } = useAiTrainingJobContext();
 
   const handleValuesChange: FormProps["onValuesChange"] = (changedValues) => {
@@ -25,15 +25,15 @@ export const AiTrainingSettings: React.FC = () => {
     if ("comments" in changedValues) {
       setComments(changedValues.comments);
     }
-    if ("maxDistanceNm" in changedValues) {
-      setMaxDistanceNm(changedValues.maxDistanceNm);
+    if ("instanceDiameterNm" in changedValues) {
+      setInstanceDiameterNm(changedValues.instanceDiameterNm);
     }
   };
 
   const formFields = [
     { name: ["modelName"], value: modelName },
     { name: ["comments"], value: comments },
-    { name: ["maxDistanceNm"], value: maxDistanceNm },
+    { name: ["instanceDiameterNm"], value: instanceDiameterNm },
   ];
 
   return (
@@ -58,8 +58,8 @@ export const AiTrainingSettings: React.FC = () => {
             </Form.Item>
             {selectedTask?.jobType === APIJobCommand.TRAIN_INSTANCE_MODEL && (
               <Form.Item
-                name="maxDistanceNm"
-                label="Max Distance (nm)"
+                name="instanceDiameterNm"
+                label="Instance Diameter (nm)"
                 rules={[{ required: true, message: "Please enter a positive number" }]}
                 tooltip='The maximum cross-section length ("diameter") for each identified object in nm e.g. Nuclei: 1000nm, Vesicles: 80nm'
               >

unreleased_changes/9194.md

@@ -0,0 +1,2 @@
+### Fixed
+- Fixed a bug in starting AI instance segmentation model training where the selected Max Distance (now named Instance Diameter) was not respected.