Skip to content

Commit

Permalink
Merge pull request #202 from open-mmlab/zz/d
Browse files Browse the repository at this point in the history
Merge config doc into one page
  • Loading branch information
innerlee authored Feb 19, 2021
2 parents 91810f3 + f207247 commit b9cdb03
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 12 deletions.
12 changes: 0 additions & 12 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,3 @@ We follow the below style to name config files. Contributors are advised to foll
`20k` means 20,000 iterations.
`100k` means 100,000 iterations.
- `{dataset}`: dataset like `places` (for inpainting), `comp1k` (for matting), `div2k` (for restoration) and `paired` (for generation).

## Config File Structure

Please refer to the corresponding page for config file structure for different tasks.

[Inpainting](config_inpainting.md)

[Matting](config_matting.md)

[Restoration](config_restoration.md)

[Generation](config_generation.md)
3 changes: 3 additions & 0 deletions docs/merge_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,6 @@ cat ../tools/data/generation/*/*.md | sed 's/# Preparing/# /g' | sed "s/#/#&/" |
cat ../tools/data/inpainting/*/*.md | sed 's/# Preparing/# /g' | sed "s/#/#&/" | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >> inpainting_datasets.md
cat ../tools/data/matting/*/*.md | sed 's/# Preparing/# /g' | sed "s/#/#&/" | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >> matting_datasets.md
cat ../tools/data/super-resolution/*/*.md | sed 's/# Preparing/# /g' | sed "s/#/#&/" | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >> sr_datasets.md

# merge configs
cat config_*.md | sed "s/#/#&/" >> config.md

0 comments on commit b9cdb03

Please sign in to comment.