docs: update docs style #169

Gaiejj · 2023-03-21T17:35:38Z

Description

#. Change the theme from press to furo
#. Add Installation guide

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds core functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (update in the documentation)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

I have read the CONTRIBUTION guide. (required)
My change requires a change to the documentation.
I have updated the tests accordingly. (required for a bug fix or a new feature)
I have updated the documentation accordingly.
I have reformatted the code using make format. (required)
I have checked the code using make lint. (required)
I have ensured make test pass. (required)

…ent#131)

Co-authored-by: borong <borongzh@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Co-authored-by: ruiyang sun <rockmagma02@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: ruiyang sun <rockmagma02@gmail.com>

Co-authored-by: zmsn-2077 <73586554+zmsn-2077@users.noreply.github.com> Co-authored-by: borong <borongzh@gmail.com> Co-authored-by: friedmainfunction <73703265+friedmainfunction@users.noreply.github.com>

…nment#147) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

…thms (PKU-Alignment#148) Co-authored-by: borong <borongzh@gmail.com> Co-authored-by: Gaiejj <524339208@qq.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: zmsn-2077 <jiamg.ji@gmail.com>

Co-authored-by: borong <borongzh@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: ruiyang sun <rockmagma02@gmail.com> Co-authored-by: zmsn-2077 <73586554+zmsn-2077@users.noreply.github.com> Co-authored-by: friedmainfunction <73703265+friedmainfunction@users.noreply.github.com> Co-authored-by: Gaiejj <524339208@qq.com> Co-authored-by: zmsn-2077 <jiamg.ji@gmail.com> Co-authored-by: Ruiyang Sun <rockmagma02@gmail.com> Co-authored-by: Jiayi Zhou <108712610+Gaiejj@users.noreply.github.com> Co-authored-by: 1Asan <99461435+1Asan@users.noreply.github.com> fix(algo): fix no return in algo_wrapper::learn (PKU-Alignment#122) fix(logger, wrapper): support csv file and velocity tasks (PKU-Alignment#131) fix typo. (PKU-Alignment#134) fix(ppo): fix entropy loss (PKU-Alignment#135) fix bugs (PKU-Alignment#136) fix: support new config for exp_grid (PKU-Alignment#142) fix(rollout, exp_grid): fix logdir path conflict (PKU-Alignment#145) fix(on-policy): fix the second order algorithms performance (PKU-Alignment#147)

…lignment#162) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: borong <borongzh@gmail.com>

…nto dev-action

…o dev-docs

codecov · 2023-03-22T02:39:08Z

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.02 ⚠️

Comparison is base (2f04f4a) 86.43% compared to head (7e63666) 86.42%.

❗ Current head 7e63666 differs from pull request most recent head f48f6fc. Consider uploading reports for the commit f48f6fc to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##              dev     #169      +/-   ##
==========================================
- Coverage   86.43%   86.42%   -0.02%     
==========================================
  Files          80       80              
  Lines        3760     3757       -3     
==========================================
- Hits         3250     3247       -3     
  Misses        510      510

Impacted Files	Coverage Δ
omnisafe/algorithms/on_policy/base/ppo.py	`100.00% <ø> (ø)`
omnisafe/algorithms/on_policy/base/trpo.py	`89.85% <ø> (ø)`
omnisafe/algorithms/on_policy/first_order/cup.py	`96.05% <ø> (ø)`
...nisafe/algorithms/on_policy/naive_lagrange/crpo.py	`90.90% <ø> (-1.10%)`	⬇️
...afe/algorithms/on_policy/naive_lagrange/ppo_lag.py	`100.00% <ø> (ø)`
...fe/algorithms/on_policy/naive_lagrange/trpo_lag.py	`100.00% <ø> (ø)`
...isafe/algorithms/on_policy/penalty_function/ipo.py	`93.75% <ø> (ø)`
...isafe/algorithms/on_policy/penalty_function/p3o.py	`100.00% <ø> (ø)`
omnisafe/algorithms/on_policy/second_order/cpo.py	`73.42% <ø> (ø)`
omnisafe/algorithms/on_policy/second_order/pcpo.py	`100.00% <ø> (ø)`
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

…o dev-docs

zmsn-2077

LGTM.

friedmainfunction

LGTM.

rockmagma02 and others added 30 commits March 15, 2023 02:53

refactor: change architecture of omnisafe (PKU-Alignment#121)

4987e80

fix(algo): fix no return in algo_wrapper::learn (PKU-Alignment#122)

90f7549

chore: support num_thread setting (PKU-Alignment#124)

16be6a8

feat: update architecture of config.yaml (PKU-Alignment#126)

51e7f96

fix(logger, wrapper): support csv file and velocity tasks (PKU-Alignm…

2aa1417

…ent#131)

chore: fix typo. (PKU-Alignment#134)

04477eb

fix(ppo): fix entropy loss (PKU-Alignment#135)

fe686bb

test: add more test case, and fix bugs (PKU-Alignment#136)

63dc035

fix: support new config for exp_grid (PKU-Alignment#142)

8b32d73

Co-authored-by: borong <borongzh@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

feat: support policy evaluation (PKU-Alignment#137)

06dcbdb

Co-authored-by: ruiyang sun <rockmagma02@gmail.com>

feat(off-policy): add DDPG, TD3 SAC (PKU-Alignment#128)

c232fcf

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: ruiyang sun <rockmagma02@gmail.com>

fix(rollout, exp_grid): fix logdir path conflict (PKU-Alignment#145)

78ec6bd

Co-authored-by: zmsn-2077 <73586554+zmsn-2077@users.noreply.github.com> Co-authored-by: borong <borongzh@gmail.com> Co-authored-by: friedmainfunction <73703265+friedmainfunction@users.noreply.github.com>

fix(on-policy): fix the second order algorithms performance (PKU-Alig…

817edf9

…nment#147) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

docs: update README.md (PKU-Alignment#149)

cb633d6

docs: update changelog and release v0.1.0

ba48512

chore: update yaml (PKU-Alignment#155)

8463ca5

chore: update github workflow (PKU-Alignment#156)

5068262

feat: support cuda

6c1ed1d

feat: support cuda exp grid

3380d75

chore: merge dev branch

f43f32c

fix(onpolicy_adapter): fix the calculation of last state value (PKU-A…

973b363

…lignment#162) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: borong <borongzh@gmail.com>

Merge branch 'dev' into dev-action

cb1544c

fix: [pre-commit.ci] auto fixes [...]

2a294a4

fix: disable test cuda

065e22d

Merge branch 'PKU-MARL:dev' into dev

335f424

chore: rebase dev branch

e722980

Merge branch 'dev-action' of https://github.com/Gaiejj/omnisafe_zjy i…

d63c4f2

…nto dev-action

feat: support cuda

2ba25ff

Gaiejj added 7 commits March 20, 2023 22:34

chore: update yaml

e285dba

docs: update comment

131c636

docs: update README

758ef5e

Merge branch 'dev-docs' of https://github.com/Gaiejj/omnisafe_zjy int…

ece2f0b

…o dev-docs

docs: update docs style

a4c728d

docs: delete empty docs

a3e9ed5

docs: delete empty docs

6037a49

Gaiejj and others added 15 commits March 22, 2023 10:43

docs: delete empty docs

c973eb0

docs: update read the docs yaml

64fe083

docs: update second order docs

f2518ff

docs: support pdf output

364dffa

docs: revert pdf output

2f5ab47

docs: update color style

e436510

docs: update equation style

aa6641c

fix: [pre-commit.ci] auto fixes [...]

2784ff7

docs: fix unindent

85ea983

Merge branch 'dev-docs' of https://github.com/Gaiejj/omnisafe_zjy int…

5d3f138

…o dev-docs

fix: [pre-commit.ci] auto fixes [...]

dc04498

docs: fix equation render

f08b20d

fix: [pre-commit.ci] auto fixes [...]

769de96

docs: update intro

10bf5e3

Merge branch 'dev-docs' of https://github.com/Gaiejj/omnisafe_zjy int…

f48f6fc

…o dev-docs

zmsn-2077 approved these changes Mar 23, 2023

View reviewed changes

friedmainfunction approved these changes Mar 24, 2023

View reviewed changes

Gaiejj merged commit 9fa17e5 into PKU-Alignment:dev Mar 24, 2023

Gaiejj deleted the dev-docs branch March 24, 2023 05:08

Gaiejj restored the dev-docs branch March 26, 2023 16:56

zmsn-2077 pushed a commit that referenced this pull request Mar 26, 2023

docs: update docs style (#169)

a57ff0c

Gaiejj deleted the dev-docs branch March 27, 2023 08:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update docs style #169

docs: update docs style #169

Gaiejj commented Mar 21, 2023

codecov bot commented Mar 22, 2023 •

edited

zmsn-2077 left a comment

friedmainfunction left a comment

docs: update docs style #169

docs: update docs style #169

Conversation

Gaiejj commented Mar 21, 2023

Description

Types of changes

Checklist

codecov bot commented Mar 22, 2023 • edited

Codecov Report

zmsn-2077 left a comment

Choose a reason for hiding this comment

friedmainfunction left a comment

Choose a reason for hiding this comment

codecov bot commented Mar 22, 2023 •

edited