documentation involving pcb-aoi singletask and incremental learning c…

…orrected documentation involving pcb-aoi singletask and incremental learning corrected Signed-off-by: Aryan Nanda <[email protected]> path error corrected Signed-off-by: Aryan Nanda <[email protected]>
kubeedge · Feb 2, 2025 · 5f467b7 · 5f467b7
1 parent 8260643
commit 5f467b7
Show file tree

Hide file tree

Showing 10 changed files with 67 additions and 61 deletions.
diff --git a/docs/guides/how-to-build-simulation-env.md b/docs/guides/how-to-build-simulation-env.md
@@ -38,11 +38,11 @@ benchmarkingjob:
   name: "benchmarkingjob"
   # the url address of job workspace that will reserve the output of tests; string type;
   # default value: "./workspace"
-  workspace: "/ianvs/incremental_learning_bench/workspace"
+  workspace: "./workspace/incremental_learning_bench"
 
   # the url address of test environment configuration file; string type;
   # the file format supports yaml/yml;
-  testenv: "./examples/pcb-aoi/incremental_learning_bench/testenv/testenv.yaml"
+  testenv: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/testenv.yaml"
   # the configuration of test object
   test_object:
     ...

diff --git a/docs/guides/how-to-contribute-test-environments.md b/docs/guides/how-to-contribute-test-environments.md
@@ -20,9 +20,9 @@ testenv:
   # dataset configuration
   dataset:
     # the url address of train dataset index; string type;
-    train_url: "/ianvs/dataset/train_data/index.txt"
+    train_index: "./dataset/train_data/index.txt"
     # the url address of test dataset index; string type;
-    test_url: "/ianvs/dataset/test_data/index.txt"
+    test_index: "./dataset/test_data/index.txt"
 
   # model eval configuration of incremental learning;
   model_eval:
@@ -31,7 +31,7 @@ testenv:
       # metric name; string type;
       name: "f1_score"
       # the url address of python file
-      url: "./examples/pcb-aoi/incremental_learning_bench/testenv/f1_score.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/f1_score.py"
 
     # condition of triggering inference model to update
     # threshold of the condition; types are float/int
@@ -45,7 +45,7 @@ testenv:
       # metric name; string type;
     - name: "f1_score"
       # the url address of python file
-      url: "./examples/pcb-aoi/incremental_learning_bench/testenv/f1_score.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/f1_score.py"
     - name: "samples_transfer_ratio"
 
   # incremental rounds setting for incremental learning paradigm.; int type; default value is 2;

diff --git a/docs/guides/how-to-test-algorithms.md b/docs/guides/how-to-test-algorithms.md
@@ -27,9 +27,9 @@ testenv:
   # dataset configuration
   dataset:
     # the url address of train dataset index; string type;
-    train_url: "/ianvs/dataset/train_data/index.txt"
+    train_index: "./dataset/train_data/index.txt"
     # the url address of test dataset index; string type;
-    test_url: "/ianvs/dataset/test_data/index.txt"
+    test_index: "./dataset/test_data/index.txt"
 
   # model eval configuration of incremental learning;
   model_eval:
@@ -38,7 +38,7 @@ testenv:
       # metric name; string type;
       name: "f1_score"
       # the url address of python file
-      url: "./examples/pcb-aoi/incremental_learning_bench/testenv/f1_score.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/f1_score.py"
 
     # condition of triggering inference model to update
     # threshold of the condition; types are float/int
@@ -52,7 +52,7 @@ testenv:
       # metric name; string type;
     - name: "f1_score"
       # the url address of python file
-      url: "./examples/pcb-aoi/incremental_learning_bench/testenv/f1_score.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/f1_score.py"
     - name: "samples_transfer_ratio"
 
   # incremental rounds setting for incremental learning paradigm.; int type; default value is 2;
@@ -63,7 +63,7 @@ The URL address of this test environment, i.e., testenv.yaml, then should be fil
 
 ``` yaml
 # benchmarkingJob.yaml
-  testenv: "./examples/pcb-aoi/benchmarkingjob/testenv/testenv.yaml"
+  testenv: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/testenv.yaml"
 ```
 
 ## Step 2. Test Case Preparation
@@ -252,7 +252,7 @@ algorithm:
     #   1> "default": the dataset is evenly divided based train_ratio;
     splitting_method: "default"
   # the url address of initial model for model pre-training; string url;
-  initial_model_url: "/ianvs/initial_model/model.zip"
+  initial_model_url: "./initial_model/model.zip"
 
   # algorithm module configuration in the paradigm; list type;
   modules:
@@ -264,7 +264,7 @@ algorithm:
       # example: basemodel.py has BaseModel module that the alias is "FPN" for this benchmarking;
       name: "FPN"
       # the url address of python module; string type;
-      url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/basemodel.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/basemodel.py"
 
       # hyperparameters configuration for the python module; list type;
       hyperparameters:
@@ -283,7 +283,7 @@ algorithm:
       # name of python module; string type;
       name: "IBT"
       # the url address of python module; string type;
-      url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/hard_example_mining.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/hard_example_mining.py"
       # hyperparameters configuration for the python module; list type;
       hyperparameters:
         # name of the hyperparameter; string type;
@@ -311,7 +311,7 @@ The URL address of this algorithm then should be filled in the configuration fil
       - name: "fpn_incremental_learning"
         # the url address of test algorithm configuration file; string type;
         # the file format supports yaml/yml
-        url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/fpn_algorithm.yaml"
+        url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/fpn_algorithm.yaml"
 ```
 
 or
@@ -328,7 +328,7 @@ or
       - name: "fpn_singletask_learning"
         # the url address of test algorithm configuration file; string type;
         # the file format supports yaml/yml;
-        url: "./examples/pcb-aoi/singletask_learning_bench/testalgorithms/fpn/fpn_algorithm.yaml"
+        url: "./examples/pcb-aoi/singletask_learning_bench/fault_detection/testalgorithms/fpn/fpn_algorithm.yaml"
 ```
 
 ## Step 3. ianvs Configuration
@@ -339,20 +339,21 @@ First, the user can configure the workspace to reserve the output of tests.
 
 ``` yaml
 # benchmarkingJob.yaml
-  workspace: "/ianvs/pcb-aoi/workspace/"
+  workspace: "./workspace/incremental_learning_bench"
 ```
 
 Then, the user fill in the test environment and algorithm configured in previous steps. 
 
 ``` yaml
 # benchmarkingJob.yaml
-  testenv: ".examples/pcb-aoi/benchmarkingjob/testenv/testenv.yaml"
+  testenv: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/testenv.yaml"
 ```
 
 ``` yaml
+# benchmarkingJob.yaml
   algorithms:
     - name: "fpn_incremental_learning"
-      url: "./examples/pcb-aoi/benchmarkingjob/testalgorithms/fpn_incremental_learning/fpn_algorithm.yaml"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/fpn_algorithm.yaml"
 ```
 
 As the final leaderboard, the user can configure how to rank the leaderboard with the specific metric and order.

diff --git a/...n-industrial-defect-detection-of-PCB-AoI/leaderboard-of-single-task-learning.md b/...n-industrial-defect-detection-of-PCB-AoI/leaderboard-of-single-task-learning.md
@@ -2,7 +2,8 @@
 
 
 
-|rank  |algorithm                |f1_score  |paradigm            |basemodel  |learning_rate  |momentum  |time                      |
-|:----:|:-----------------------:|:--------:|:------------------:|:---------:|:-------------:|:--------:|:------------------------ |
-|1     |fpn_singletask_learning  | 0.8396   |singletasklearning  | FPN       | 0.1           | 0.5      | 2022-07-07 20:33:53      |
-|2     |fpn_singletask_learning  | 0.8353   |singletasklearning  | FPN       | 0.1           | 0.95     | 2022-07-07 20:31:08      |
+
+| rank | algorithm                | f1_score | paradigm            | basemodel | basemodel-momentum | basemodel-learning_rate | time                  | url                                                                                      |
+|:----:|:------------------------:|:--------:|:------------------:|:---------:|:------------------:|:---------------------:|:---------------------:|:--------------------------------------------------------------------------------------- |
+|  1   | fpn_singletask_learning  |  0.8527  | singletasklearning  |    FPN    |        0.5         |           0.1         | 2025-01-06 14:30:30  | ./workspace/benchmarkingjob/fpn_singletask_learning/3a76bc25-cc0b-11ef-9f00-65cc74a7c013 |
+|  2   | fpn_singletask_learning  |  0.8440  | singletasklearning  |    FPN    |        0.95        |           0.1         | 2025-01-06 14:25:18  | ./workspace/benchmarkingjob/fpn_singletask_learning/3a76bc24-cc0b-11ef-9f00-65cc74a7c013 |
diff --git a/...rts/testing-incremental-learning-in-industrial-defect-detection-with-pcb-aoi.md b/...rts/testing-incremental-learning-in-industrial-defect-detection-with-pcb-aoi.md
@@ -39,9 +39,9 @@ testenv:
   # dataset configuration
   dataset:
     # the url address of train dataset index; string type;
-    train_url: "/ianvs/dataset/train_data/index.txt"
+    train_index: "./dataset/train_data/index.txt"
     # the url address of test dataset index; string type;
-    test_url: "/ianvs/dataset/test_data/index.txt"
+    test_index: "./dataset/test_data/index.txt"
 
   # model eval configuration of incremental learning;
   model_eval:
@@ -50,7 +50,7 @@ testenv:
       # metric name; string type;
       name: "f1_score"
       # the url address of python file
-      url: "./examples/pcb-aoi/incremental_learning_bench/testenv/f1_score.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/f1_score.py"
 
     # condition of triggering inference model to update
     # threshold of the condition; types are float/int
@@ -64,7 +64,7 @@ testenv:
       # metric name; string type;
     - name: "f1_score"
       # the url address of python file
-      url: "./examples/pcb-aoi/incremental_learning_bench/testenv/f1_score.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/f1_score.py"
     - name: "samples_transfer_ratio"
 
   # incremental rounds setting for incremental learning paradigm.; int type; default value is 2;
@@ -90,7 +90,7 @@ algorithm:
     #   1> "default": the dataset is evenly divided based train_ratio;
     splitting_method: "default"
   # the url address of initial model for model pre-training; string url;
-  initial_model_url: "/ianvs/initial_model/model.zip"
+  initial_model_url: "./initial_model/model.zip"
 
   # algorithm module configuration in the paradigm; list type;
   modules:
@@ -102,7 +102,7 @@ algorithm:
       # example: basemodel.py has BaseModel module that the alias is "FPN" for this benchmarking;
       name: "FPN"
       # the url address of python module; string type;
-      url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/basemodel.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/basemodel.py"
 
       # hyperparameters configuration for the python module; list type;
       hyperparameters:
@@ -118,13 +118,13 @@ algorithm:
             # the url addresses of hyperparameters configuration files; list type;
             # type of the value is string;
             values:
-              - "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/fpn_hyperparameter.yaml"
+              - "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/fpn_hyperparameter.yaml"
       #  2> "hard_example_mining": check hard example when predict ; optional module;
     - type: "hard_example_mining"
       # name of python module; string type;
       name: "IBT"
       # the url address of python module; string type;
-      url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/hard_example_mining.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/hard_example_mining.py"
       # hyperparameters configuration for the python module; list type;
       hyperparameters:
         # name of the hyperparameter; string type;

diff --git a/...rts/testing-single-task-learning-in-industrial-defect-detection-with-pcb-aoi.md b/...rts/testing-single-task-learning-in-industrial-defect-detection-with-pcb-aoi.md
@@ -30,16 +30,16 @@ testenv:
   # dataset configuration
   dataset:
     # the url address of train dataset index; string type;
-    train_url: "/ianvs/dataset/train_data/index.txt"
+    train_index: "./dataset/train_data/index.txt"
     # the url address of test dataset index; string type;
-    test_url: "/ianvs/dataset/test_data/index.txt"
+    test_index: "./dataset/test_data/index.txt"
 
   # metrics configuration for test case's evaluation; list type;
   metrics:
     # metric name; string type;
     - name: "f1_score"
       # the url address of python file
-      url: "./examples/pcb-aoi/singletask_learning_bench/testenv/f1_score.py"
+      url: "./examples/pcb-aoi/singletask_learning_bench/fault_detection/testenv/f1_score.py"
 ```
 
 Key settings of the algorithm to single learning are as follows:
@@ -53,7 +53,7 @@ algorithm:
   #   2> "incrementallearning"
   paradigm_type: "singletasklearning"
   # the url address of initial model; string type; optional;
-  initial_model_url: "/ianvs/initial_model/model.zip"
+  initial_model_url: "./initial_model/model.zip"
 
   # algorithm module configuration in the paradigm; list type;
   modules:
@@ -65,7 +65,7 @@ algorithm:
       # example: basemodel.py has BaseModel module that the alias is "FPN" for this benchmarking;
       name: "FPN"
       # the url address of python module; string type;
-      url: "./examples/pcb-aoi/singletask_learning_bench/testalgorithms/fpn/basemodel.py"
+      url: "./examples/pcb-aoi/singletask_learning_bench/fault_detection/testalgorithms/fpn/basemodel.py"
 
       # hyperparameters configuration for the python module; list type;
       hyperparameters:
@@ -81,7 +81,7 @@ algorithm:
             # the url addresses of hyperparameters configuration files; list type;
             # type of the value is string;
             values:
-              - "./examples/pcb-aoi/singletask_learning_bench/testalgorithms/fpn/fpn_hyperparameter.yaml"
+              - "./examples/pcb-aoi/singletask_learning_bench/fault_detection/testalgorithms/fpn/fpn_hyperparameter.yaml"
 
 ```
 

diff --git a/docs/user_interface/how-to-config-algorithm.md b/docs/user_interface/how-to-config-algorithm.md
@@ -24,7 +24,7 @@ algorithm:
   incremental_learning_data_setting:
     ...
   # the url address of initial model for model pre-training; string url;
-  initial_model_url: "/ianvs/initial_model/model.zip"
+  initial_model_url: "./initial_model/model.zip"
 
   # algorithm module configuration in the paradigm; list type;
   modules:
@@ -73,7 +73,7 @@ modules:
     # example: basemodel.py has BaseModel module that the alias is "FPN" for this benchmarking;
     name: "FPN"
     # the url address of python module; string type;
-    url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/basemodel.py"
+    url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/basemodel.py"
 
     # hyperparameters configuration for the python module; list type;
     hyperparameters:
@@ -83,7 +83,7 @@ modules:
     # name of python module; string type;
     name: "IBT"
     # the url address of python module; string type;
-    url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/hard_example_mining.py"
+    url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/hard_example_mining.py"
     # hyperparameters configuration for the python module; list type;
     hyperparameters:
       ...
@@ -141,7 +141,7 @@ algorithm:
     #   1> "default": the dataset is evenly divided based train_ratio;
     splitting_method: "default"
   # the url address of initial model for model pre-training; string url;
-  initial_model_url: "/ianvs/initial_model/model.zip"
+  initial_model_url: "./initial_model/model.zip"
 
   # algorithm module configuration in the paradigm; list type;
   modules:
@@ -153,7 +153,7 @@ algorithm:
       # example: basemodel.py has BaseModel module that the alias is "FPN" for this benchmarking;
       name: "FPN"
       # the url address of python module; string type;
-      url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/basemodel.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/basemodel.py"
 
       # hyperparameters configuration for the python module; list type;
       hyperparameters:
@@ -172,7 +172,7 @@ algorithm:
       # name of python module; string type;
       name: "IBT"
       # the url address of python module; string type;
-      url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/hard_example_mining.py"
+      url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/hard_example_mining.py"
       # hyperparameters configuration for the python module; list type;
       hyperparameters:
         # name of the hyperparameter; string type;

diff --git a/docs/user_interface/how-to-config-benchmarkingjob.md b/docs/user_interface/how-to-config-benchmarkingjob.md
@@ -20,11 +20,11 @@ benchmarkingjob:
   name: "benchmarkingjob"
   # the url address of job workspace that will reserve the output of tests; string type;
   # default value: "./workspace"
-  workspace: "/ianvs/incremental_learning_bench/workspace"
+  workspace: "./workspace/incremental_learning_bench"
 
   # the url address of test environment configuration file; string type;
   # the file format supports yaml/yml;
-  testenv: "./examples/pcb-aoi/incremental_learning_bench/testenv/testenv.yaml"
+  testenv: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/testenv.yaml"
   # the configuration of test object
   test_object:
     ...
@@ -69,7 +69,7 @@ algorithms:
   - name: "fpn_incremental_learning"
   # the url address of test algorithm configuration file; string type;
   # the file format supports yaml/yml
-  url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/fpn_algorithm.yaml"
+  url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/fpn_algorithm.yaml"
 ```
 
 ### The configuration of rank
@@ -166,11 +166,11 @@ benchmarkingjob:
   name: "benchmarkingjob"
   # the url address of job workspace that will reserve the output of tests; string type;
   # default value: "./workspace"
-  workspace: "/ianvs/incremental_learning_bench/workspace"
+  workspace: "./workspace/incremental_learning_bench"
 
   # the url address of test environment configuration file; string type;
   # the file format supports yaml/yml;
-  testenv: "./examples/pcb-aoi/incremental_learning_bench/testenv/testenv.yaml"
+  testenv: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testenv/testenv.yaml"
 
   # the configuration of test object
   test_object:
@@ -183,7 +183,7 @@ benchmarkingjob:
       - name: "fpn_incremental_learning"
         # the url address of test algorithm configuration file; string type;
         # the file format supports yaml/yml
-        url: "./examples/pcb-aoi/incremental_learning_bench/testalgorithms/fpn/fpn_algorithm.yaml"
+        url: "./examples/pcb-aoi/incremental_learning_bench/fault_detection/testalgorithms/fpn/fpn_algorithm.yaml"
 
   # the configuration of ranking leaderboard
   rank: