Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README.md for configs (an example) #285

Merged
merged 1 commit into from
Aug 5, 2022
Merged

Add README.md for configs (an example) #285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions federatedscope/core/configs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. | - |