Skip to content

Commit a343748

Browse files
leto-bbqleto-bbq
authored
Fix latest user guide doc formatting issues (#1163)
1 parent 65f4341 commit a343748

70 files changed

Lines changed: 244 additions & 249 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/UserGuide/latest-Table/AI-capability/AINode_apache.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -105,21 +105,21 @@ Detailed meanings of SQL parameters:
105105

106106
- **Model configuration file**: Parameters related to the model structure provided during registration, which must include input and output dimensions for inference:
107107

108-
| **Parameter Name** | **Description** | **Example** |
109-
| ------------ | ---------------------------- | -------- |
110-
| input_shape | Rows and columns of model input | [96,2] |
111-
| output_shape | Rows and columns of model output | [48,2] |
108+
| **Parameter Name** | **Description** | **Example** |
109+
| ------------------ | -------------------------------- | ----------- |
110+
| input_shape | Rows and columns of model input | [96,2] |
111+
| output_shape | Rows and columns of model output | [48,2] |
112112

113113
In addition to inference, data types of input and output can also be specified:
114114

115-
| **Parameter Name** | **Description** | **Example** |
115+
| **Parameter Name** | **Description** | **Example** |
116116
| ------------------ | ------------------------- | ---------------------- |
117117
| input_type | Data type of model input | ['float32', 'float32'] |
118118
| output_type | Data type of model output | ['float32', 'float32'] |
119119

120120
Additional notes can be specified for model management display:
121121

122-
| **Parameter Name** | **Description** | **Example** |
122+
| **Parameter Name** | **Description** | **Example** |
123123
| ------------------ | --------------------------------------------- | -------------------------------------------- |
124124
| attributes | Optional notes set by users for model display | 'model_type': 'dlinear', 'kernel_size': '25' |
125125

@@ -407,4 +407,4 @@ AINode uses IoTDB's authentication for permission management. Users need `USE_MO
407407
| initialization_method | Initialization method: - `"estimated"`: Fit to estimate initial states - `"heuristic"`: Use heuristic for initial level/trend/season - `"known"`: User-provided initial values - `"legacy-heuristic"`: Legacy compatibility | "estimated" |
408408
| optimized | Optimize parameters via maximum likelihood. | True |
409409
| remove_bias | Remove bias to make residuals' mean zero. | False |
410-
| use_brute | Use brute-force grid search for initial parameters. | |
410+
| use_brute | Use brute-force grid search for initial parameters. | |

‎src/UserGuide/latest-Table/AI-capability/AINode_timecho.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -104,21 +104,21 @@ Detailed meanings of SQL parameters:
104104

105105
- **Model configuration file**: Parameters related to the model structure provided during registration, which must include input and output dimensions for inference:
106106

107-
| **Parameter Name** | **Description** | **Example** |
108-
| ------------ | ---------------------------- | -------- |
109-
| input_shape | Rows and columns of model input | [96,2] |
110-
| output_shape | Rows and columns of model output | [48,2] |
107+
| **Parameter Name** | **Description** | **Example** |
108+
| ------------------ | -------------------------------- | ----------- |
109+
| input_shape | Rows and columns of model input | [96,2] |
110+
| output_shape | Rows and columns of model output | [48,2] |
111111

112112
In addition to inference, data types of input and output can also be specified:
113113

114-
| **Parameter Name** | **Description** | **Example** |
114+
| **Parameter Name** | **Description** | **Example** |
115115
| ------------------ | ------------------------- | ---------------------- |
116116
| input_type | Data type of model input | ['float32', 'float32'] |
117117
| output_type | Data type of model output | ['float32', 'float32'] |
118118

119119
Additional notes can be specified for model management display:
120120

121-
| **Parameter Name** | **Description** | **Example** |
121+
| **Parameter Name** | **Description** | **Example** |
122122
| ------------------ | --------------------------------------------- | -------------------------------------------- |
123123
| attributes | Optional notes set by users for model display | 'model_type': 'dlinear', 'kernel_size': '25' |
124124

@@ -479,4 +479,4 @@ AINode uses IoTDB's authentication for permission management. Users need `USE_MO
479479
| initialization_method | Initialization method: - `"estimated"`: Fit to estimate initial states - `"heuristic"`: Use heuristic for initial level/trend/season - `"known"`: User-provided initial values - `"legacy-heuristic"`: Legacy compatibility | "estimated" |
480480
| optimized | Optimize parameters via maximum likelihood. | True |
481481
| remove_bias | Remove bias to make residuals' mean zero. | False |
482-
| use_brute | Use brute-force grid search for initial parameters. | |
482+
| use_brute | Use brute-force grid search for initial parameters. | |

‎src/UserGuide/latest-Table/API/Programming-Python-Native-API_timecho.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ if has_next:
7070

7171
| Function Name | Description | Parameters | Return Value |
7272
|---------------|-------------|------------|--------------|
73-
| `encode_object_cell` | Encodes a single OBJECT cell into wire-format bytes | `is_eof: bool`,<br>`offset: int`,<br>`content: bytes` | `bytes`: `|[eof 1B]|[offset 8B BE]|[payload]|` |
73+
| `encode_object_cell` | Encodes a single OBJECT cell into wire-format bytes | `is_eof: bool`,<br>`offset: int`,<br>`content: bytes` | `bytes`: `\|[eof 1B]\|[offset 8B BE]\|[payload]\|` |
7474
| `decode_object_cell` | Parses a wire-format cell back into `eof`, `offset`, and `payload` | `cell: bytes` (length ≥ 9) | `Tuple[bool, int, bytes]`: `(is_eof, offset, payload)` |
7575
| `Tablet.add_value_object` | Writes an OBJECT cell at the specified row and column (internally calls `encode_object_cell`) | `row_index: int`,<br>`column_index: int`,<br>`is_eof: bool`,<br>`offset: int`,<br>`content: bytes` | `None` |
7676
| `Tablet.add_value_object_by_name` | Same as above, locates column by name | `column_name: str`,<br>`row_index: int`,<br>`is_eof: bool`,<br>`offset: int`,<br>`content: bytes` | `None` |
@@ -749,4 +749,4 @@ def test_table_numpy_tablet_object_columns(table_session):
749749

750750
if __name__ == "__main__":
751751
pytest.main([__file__, "-v", "-rs"])
752-
```
752+
```

‎src/UserGuide/latest-Table/Tools-System/Schema-Export-Tool_apache.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The schema export tool `export-schema.sh/bat` is located in the `tools` director
3131

3232
| **Short Param** | **Full Param** | **Description** | Required | Default |
3333
|-----------------|--------------------------|--------------------------------------------------------------------------| ------------------------------------- |---------------------------------------------|
34-
| `-h` | `-- host` | Hostname | No | 127.0.0.1 |
34+
| `-h` | `--host` | Hostname | No | 127.0.0.1 |
3535
| `-p` | `--port` | Port number | No | 6667 |
3636
| `-u` | `--username` | Username | No | root |
3737
| `-pw` | `--password` | Password. Supported for hidden input since V2.0.9-beta | No | root |

‎src/UserGuide/latest-Table/Tools-System/Schema-Export-Tool_timecho.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The schema export tool `export-schema.sh/bat` is located in the `tools` director
3131

3232
| **Short Param** | **Full Param** | **Description** | Required | Default |
3333
|-----------------|----------------------------|-----------------------------------------------------------------------| ------------------------------------- |-----------------------------------------------|
34-
| `-h` | `-- host` | Hostname | No | 127.0.0.1 |
34+
| `-h` | `--host` | Hostname | No | 127.0.0.1 |
3535
| `-p` | `--port` | Port number | No | 6667 |
3636
| `-u` | `--username` | Username | No | root |
3737
| `-pw` | `--password` | Password, Supported for hidden input since V2.0.9.1 | No | `TimechoDB@2021`(Before V2.0.6 it is root) |

‎src/UserGuide/latest-Table/Tools-System/Schema-Import-Tool_apache.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The schema import tool `import-schema.sh/bat` is located in `tools` directory.
3131

3232
| **Short Param** | **Full Param** | **Description** | Required | Default |
3333
|-----------------|---------------------------|--------------------------------------------------------------------------| ---------- |-------------------------------------------|
34-
| `-h` | `-- host` | Hostname | No | 127.0.0.1 |
34+
| `-h` | `--host` | Hostname | No | 127.0.0.1 |
3535
| `-p` | `--port` | Port number | No | 6667 |
3636
| `-u` | `--username` | Username | No | root |
3737
| `-pw` | `--password` | Password. Supported for hidden input since V2.0.9-beta | No | root |

‎src/UserGuide/latest-Table/Tools-System/Schema-Import-Tool_timecho.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The schema import tool `import-schema.sh/bat` is located in `tools` directory.
3131

3232
| **Short Param** | **Full Param** | **Description** | Required | Default |
3333
|-----------------| ------------------------------- |-----------------------------------------------------------------------| ---------- |----------------------------------------------|
34-
| `-h` | `-- host` | Hostname | No | 127.0.0.1 |
34+
| `-h` | `--host` | Hostname | No | 127.0.0.1 |
3535
| `-p` | `--port` | Port number | No | 6667 |
3636
| `-u` | `--username` | Username | No | root |
3737
| `-pw` | `--password` | Password, Supported for hidden input since V2.0.9.1 | No | `TimechoDB@2021`(Before V2.0.6 it is root) |

‎src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -84,22 +84,22 @@ By declaratively configuring these three parts in an SQL statement, flexible dat
8484
- The `pipe` and `pipe plugins` for tree modes and table modes are designed to be isolated from each other. Before creating a `pipe`, it is recommended to first use the `show` command to query the built-in plugins available under the current `-sql_dialect` parameter configuration to ensure syntax compatibility and functional support.
8585
- When Pipe fails to write data to the sink due to field type mismatches, IoTDB automatically converts the data to the field types defined in the existing sink schema and retries the write operation to improve synchronization success rate. This feature is controlled by the parameter `sink.exception.data.convert-on-type-mismatch`. Refer to the subsequent sink parameter table for detailed parameter descriptions.
8686

87-
* The conversion rules for type mismatches are as follows:
88-
89-
| Source Type | Target Type | Conversion Rule |
90-
|---------------------|-------------|---------------------------------------------------------------------------------|
91-
| Numeric Type | Numeric Type| Convert to the target numeric type. Truncation, precision loss or overflow may occur. |
92-
| Numeric Type | BOOLEAN | `0` is converted to `false`; non-zero values are converted to `true`. |
93-
| BOOLEAN | Numeric Type| `true` is converted to `1`; `false` is converted to `0`. |
94-
| TEXT, STRING, BLOB | BOOLEAN | Parse the string into a BOOLEAN value. |
95-
| TEXT, STRING, BLOB | Numeric Type| Parse the string into the target numeric type. If parsing fails, write the default value `0`, `0L` or `0.0`. |
96-
| TEXT, STRING, BLOB | TIMESTAMP | Parse the string into a TIMESTAMP value. If parsing fails, write the default value `0L`. |
97-
| TEXT, STRING, BLOB | DATE | Parse the string into a DATE value. If parsing fails, write the default date `1970-01-01`. |
98-
| Invalid Numeric Value | DATE | If conversion to a valid DATE fails, write the default date `1970-01-01`. |
99-
| DATE | TIMESTAMP | Convert to the timestamp of 00:00 (UTC) on the same day. |
100-
| TIMESTAMP | DATE | Convert to the corresponding date in UTC. |
101-
102-
> **Note**: Automatic conversion is performed based on the existing sink schema and will **not** modify the sink schema. This feature prioritizes continuous data synchronization, which may result in precision loss or writing of default values.
87+
The conversion rules for type mismatches are as follows:
88+
89+
| Source Type | Target Type | Conversion Rule |
90+
| --------------------- | ------------ | --------------- |
91+
| Numeric Type | Numeric Type | Convert to the target numeric type. Truncation, precision loss, or overflow may occur. |
92+
| Numeric Type | BOOLEAN | `0` is converted to `false`; non-zero values are converted to `true`. |
93+
| BOOLEAN | Numeric Type | `true` is converted to `1`; `false` is converted to `0`. |
94+
| TEXT, STRING, BLOB | BOOLEAN | Parse the string into a BOOLEAN value. |
95+
| TEXT, STRING, BLOB | Numeric Type | Parse the string into the target numeric type. If parsing fails, write the default value `0`, `0L`, or `0.0`. |
96+
| TEXT, STRING, BLOB | TIMESTAMP | Parse the string into a TIMESTAMP value. If parsing fails, write the default value `0L`. |
97+
| TEXT, STRING, BLOB | DATE | Parse the string into a DATE value. If parsing fails, write the default date `1970-01-01`. |
98+
| Invalid Numeric Value | DATE | If conversion to a valid DATE fails, write the default date `1970-01-01`. |
99+
| DATE | TIMESTAMP | Convert to the timestamp of 00:00 (UTC) on the same day. |
100+
| TIMESTAMP | DATE | Convert to the corresponding date in UTC. |
101+
102+
> **Note**: Automatic conversion is performed based on the existing sink schema and will **not** modify the sink schema. This feature prioritizes continuous data synchronization, which may result in precision loss or writing of default values.
103103
104104
## 2. Usage Instructions
105105

0 commit comments

Comments
 (0)