[Doc] Add description of yaml #774
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
db053ed to
5faf154
Compare
docs/zh/development.md
Outdated
|
|
||
| 将已有的代码修改成配置文件控制的方式非常简单，只需要将必要的参数写到 `yaml` 文件中，然后通过 hydra 在程序运行时读取、解析该文件，通过其内容控制实验运行即可，以 `bracket` 案例为例，具体包含以下几个步骤。 | ||
|
|
||
| 1. 则需在代码文件 `bracket.py` 所在目录下新建 `conf` 文件夹，并在 `conf` 下新建与 `bracket.py` 同名的 `viv.yaml` 文件，如下所示。 |
docs/zh/development.md
Outdated
| └── viv.yaml | ||
| ``` | ||
|
|
||
| 2. 将 `viv.py` 中必要的超参数按照其语义填写到 `viv.yaml` 的各个层级的配置中，如 `mode`、`output_dir`、`seed`、方程参数、文件路径等参数为通用参数，直接填写在一级层级；而模型结构参数、训练轮数等参数则只与模型、训练相关，只需分别填写在 `MODEL`、`TRAIN` 层级下即可（`EVAL` 层级同理）。 |
There was a problem hiding this comment.
这样更通顺些
如通用参数 `mode`、`output_dir`、`seed`、方程参数、文件路径等，直接填写在一级层级
huohuohuohuohuo123
pushed a commit
to huohuohuohuohuo123/PaddleScience
that referenced
this pull request
Aug 12, 2024
* (WIP)fix doctest and refine document * update docs * fix wrong code in ldc2d * update code * update paranoma * fix * refine doc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR types
Others
PR changes
Docs
Describe