Differences

This shows you the differences between two versions of the page.

--- configuration [2024/06/03 10:53] – created liuxzh12023
+++ configuration [2025/03/30 13:52] (current) – liuxzh12023
@@ Line 1: / Line 1: @@
-Some Text about Configuration!
+===== Configuration =====
+In SLAM-Hive system, you can create a "**configuration**" before running a SLAM algorithm on a dataset. The configuration contains the algorithm, dataset and other required parameters.
+This page introduces the "**index**" page.
+------
+==== View-only Version ====
+=== 1. Combination Configuration ===
+You can click "**Show Combination Configs**" to see the created combination configurations (The detail introduction of Combination Configurations is in next section).
+=== 2. Config List ===
+The "**Config List**" shows all the created configurations.
+You can click "**Export Configuration**" button to download the configuration file in yaml format.
+And You can click "**show details**" button to see the configuration detail information online.
+=== 3. Search Engine for Configuration ===
+You can use our "Search Engine" (shown as a search box) to search your required configuration conveniently.
+The system provides multiple search conditions:
+  - Algorithms Selection (If no limitation for algorithm, select "All").
+  - Datasets Selection (If no limitation for algorithm, select "All").
+  - Parameter Selection: input a set of constraints on the parameters (The rules are similar to the "SQL").
+For example:
+<file>
+nFeatures >=2000
+nLevels = 8
+...
+</file>
+------
+==== Full Version ====
+In this page, you can create the configurations and mapping run tasks in various methods.
+=== 1. Configuration ===
+{{:config1.png?1400|}}
+{{:config2.png?1400|}}
+== 1.1 Create/Copy a Simple Configuration ==
+You can click the "**Create Config**" or "**Copy**"(in Configuration List) to create a new configuration.
+Then see [[ configuration:create | create wiki]] for more details.
+== 1.2 Show the Details of a Configuration  ==
+You can click the "**Show Config**"(in Configuration List) to show all the parameters of configuration.
+== 1.3 Create/Copy Combination Configuration ==
+We provide a convenient way to create multiple configurations at once called "Combination Configuration".
+For example, If you want to create a set of configurations with a regular pattern (e.g. set different values for parameters and then arrange them in different combinations), you can use this method.
+You can click the "**Create Combination Config**" or "**Copy for Combination**"(in Configuration List) to create a set of configurations.
+Then see [[ configuration:create_comb | create comb configurations wiki]] for more details.
+== 1.4 Show Combination Configuration ==
+You can click the "**Show Combination Config**"(in Configuration List) to show all the combination configurations.
+== 1.5 Delete Configuration ==
+If you delete the configuration, it will also delete relevant tasks and evaluations together.
+---------
+=== 2. Search Engine for Configuration Search ===
+Same as the "view-only" version.
+---------
+=== 3. Mapping Task ===
+== 3.1 Create One Mapping Task ==
+You can click the "**Create MappingTask**"(in Configuration List) to create a new configuration.
+And if you want to create more tasks of one configuration to test it's stability, you can click the "Create More MappingTask".
+== 3.2 Create a Batch of Mapping Tasks (Workstation) ==
+We provide "Batch Create Task" for you to create tasks in batches. You can input the IDs of configuration and then click the button, then the tasks will run in series.
+== 3.2 Create a Batch of Mapping Tasks (Local Cluster) ==
+Similar to the previous; the task will be assigned to the work nodes in cluster.
+== 3.3 Create a Batch of Mapping Tasks (Aliyun Cloud) ==
+Similar to the previous; System will buy new servers as work nodes, and the task will be assigned to the work nodes in cluster. After tasks finishing, the work servers will delete by system.
+For how to deployment the SLAM-Hive system on you Aliyun server, please see: https://github.com/SLAM-Hive (TODO: Add Aliyun part).