20240307, #350

docs/_posts/2023-11-05-YAML.md

@@ -0,0 +1,102 @@
+YAML (YAML Ain't Markup Language) is a highly readable format used to express data serialization, designed to be easy for humans to read and edit, while also being easily parsed by computers. `PETsARD`'s `Executor` allows users to configure the settings of PETsARD in YAML format. Through the introduction of this document, it is hoped that users can quickly get started, effortlessly set up and run their own experiments, and conveniently manage their experimental settings using YAML (See [Executor page](https://nics-tw.github.io/PETsARD/Executor.html) also).
+
+This document only explains the basic YAML settings. It is recommended to refer to the `demo/User Story...ipynb` user story scenarios in the [repository](https://github.com/nics-tw/PETsARD/tree/main/demo), which can help clarify how your requirements can be implemented.
+
+
+YAML（YAML Ain't Markup Language）是一個可讀性高，用來表達資料序列化的格式，它旨在易於人類閱讀和編輯，同時也能被電腦輕鬆解析。`PETsARD` 的 `Executor` 讓使用者以 YAML 格式配置 `PETsARD` 的程式設定，藉由本文的介紹，期待讓使用者能以最快時間上手，無痛設定並執行自己的實驗，並利用 YAML 方便管理自己的實驗設定（同時參見 [Executor 頁面](https://nics-tw.github.io/PETsARD/Executor.html)）。
+
+本文僅說明基本的 YAML 設定，建議搭配[代碼庫](https://github.com/nics-tw/PETsARD/tree/main/demo)中的 `demo/User Story...ipynb` 用戶故事情境範例，幫助釐清您的需求如何實現。
+
+```python
+Short demo # if any, only for interface
+```
+
+
+
+# Step (What does the module/class do?)
+
+Description.
+
+中文。
+
+```python
+# Detailed structure of the class
+processor = Processor(
+    metadata
+)
+```
+
+**Parameters**
+
+`parameter_name` (`expected type (if any)`, default=False): Description. 中文。
+
+## `method()`
+
+Description.
+
+中文。
+
+```python
+# Detailed structure of the function
+processor.get_config(
+    col=None
+)
+```
+
+```python
+# Output (if any)
+'Hello World!'
+```
+
+**Parameters**
+
+`parameter_name` (`expected type (if any)`): Description. 中文。
+
+**Outputs**
+
+(`expected type (if any)`): Description. 中文。
+
+## `method2()`
+
+Description.
+
+中文。
+
+```python
+# Detailed structure of the function
+processor.get_config(
+    col=None
+)
+```
+
+**Parameters**
+
+`parameter_name` (`expected type (if any)`): Description. 中文。
+
+## `method3()`
+
+Description.
+
+中文。
+
+```python
+# Detailed structure of the function
+processor.get_config()
+```
+
+**Outputs**
+
+(`expected type (if any)`): Description. 中文。
+
+## `method4()`
+
+Description.
+
+中文。
+
+```python
+# Detailed structure of the function
+processor.get_config()
+
+# If there are no parameters and outputs, this two sections can be skipped.
+```