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

Jump to bottom

update DP-GEN Docs #883

Closed
12 tasks done
HuangJiameng opened this issue Aug 17, 2022 · 6 comments
Closed
12 tasks done

update DP-GEN Docs #883

HuangJiameng opened this issue Aug 17, 2022 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@HuangJiameng
Copy link
Collaborator

HuangJiameng commented Aug 17, 2022 •
edited
Loading

  1. add docs
    • user guide
    • common-errors
  2. add tutorials
    • Handson autotest
    • Case Study : Mg-Y for dpgen run
    • Case Study : Transfer Learning for dpgen simplify
  3. update tutorials to the lastest version (v0.10.6)
    • Handson tutorial (CH4)
  4. Move the docs from README and wiki to Docs/DPGEN
    • run
    • init_bulk
    • init_surf
    • simplify
    • autotest
    • troubleshooting
@HuangJiameng HuangJiameng added the documentation Improvements or additions to documentation label Aug 17, 2022
@njzjz
Copy link
Member

njzjz commented Aug 22, 2022

Here is the current TOC:
image

I suggest merging run, init, and simplify into a section called workflow, and making each of them a chapter (the same level as "Command line interface").

@HuangJiameng
Copy link
Collaborator Author

All docs are updated to the website. TOC will be managed.

@njzjz
Copy link
Member

njzjz commented Sep 6, 2022

Since the website is ready, we may remove out-of-date contents in README.md, as we don't want to maintain two identical things. Just a confirmation, have all contents in README.md been transferred to the website?

@HuangJiameng
Copy link
Collaborator Author

The part of old dispatcher is not transferred. I'm wondering if we should keep it. This is the current introduction to machine https://docs.deepmodeling.com/projects/dpgen/en/devel/run/example-of-machine.html

@njzjz
Copy link
Member

njzjz commented Sep 7, 2022

We do not need to keep it. But I found #777 and #778 are not resolved yet.

@HuangJiameng
Copy link
Collaborator Author

OK, I will add examples for them and update arginfo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@njzjz @HuangJiameng