an example for config_readme (alibaba#285)

Schichael · Sep 7, 2022 · 15caa2b · 15caa2b
1 parent 63246f5
commit 15caa2b
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/federatedscope/core/configs/README.md b/federatedscope/core/configs/README.md
@@ -0,0 +1,9 @@
+## Configurations
+We summarize all the customizable configurations here.
+
+### Data
+The configurations related to the data/dataset are defined in `cfg_data.py`.
+
+| Name |  Type | Default Value | Choices | Description | Note |
+|:----:|:-----:|:-------------:|:-------:|:---------- |:---- |
+| data.root | string | 'data' | - | The folder where the data file located. `data.root` would be used together with `data.type` to load the dataset. | - |