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.

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

docs: polish algorithms tutorial #242

Merged
merged 12 commits into from
May 26, 2023
Merged

docs: polish algorithms tutorial #242

merged 12 commits into from
May 26, 2023

Conversation

Gaiejj
Copy link
Member

@Gaiejj Gaiejj commented May 22, 2023

Description

  • Unify symbol system
  • FIx typo
  • Polish statement

I have built the docs on https://omnisafe-zjy.readthedocs.io/en/latest/

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)

@Gaiejj Gaiejj added the documentation Improvements or additions to documentation label May 22, 2023
.github/workflows/lint.yml Outdated Show resolved Hide resolved
@Gaiejj Gaiejj requested a review from XuehaiPan as a code owner May 23, 2023 07:10
@codecov-commenter
Copy link

codecov-commenter commented May 23, 2023

Codecov Report

Merging #242 (685a226) into main (8bdcd43) will increase coverage by 3.43%.
The diff coverage is 78.79%.

❗ Current head 685a226 differs from pull request most recent head 776d6be. Consider uploading reports for the commit 776d6be to get more accurate results

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##             main     #242      +/-   ##
==========================================
+ Coverage   93.53%   96.96%   +3.43%     
==========================================
  Files         134      134              
  Lines        6905     6870      -35     
==========================================
+ Hits         6458     6661     +203     
+ Misses        447      209     -238     
Impacted Files Coverage Δ
omnisafe/adapter/modelbased_adapter.py 94.12% <ø> (+0.73%) ⬆️
omnisafe/algorithms/model_based/base/loop.py 97.87% <ø> (+4.77%) ⬆️
omnisafe/algorithms/model_based/planner/arc.py 100.00% <ø> (+2.17%) ⬆️
omnisafe/algorithms/model_based/planner/cem.py 100.00% <ø> (+2.22%) ⬆️
omnisafe/algorithms/off_policy/sac.py 100.00% <ø> (ø)
omnisafe/algorithms/off_policy/td3.py 100.00% <ø> (ø)
omnisafe/algorithms/on_policy/base/natural_pg.py 100.00% <ø> (ø)
...isafe/algorithms/on_policy/base/policy_gradient.py 100.00% <ø> (ø)
omnisafe/algorithms/on_policy/base/ppo.py 100.00% <ø> (ø)
omnisafe/algorithms/on_policy/base/trpo.py 90.14% <ø> (ø)
... and 39 more

... and 3 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Gaiejj Gaiejj requested a review from rockmagma02 as a code owner May 23, 2023 13:47
@Gaiejj Gaiejj changed the base branch from dev to main May 25, 2023 16:27
Copy link
Collaborator

@muchvo muchvo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@Gaiejj Gaiejj merged commit 25928f2 into PKU-Alignment:main May 26, 2023
4 checks passed
@Gaiejj Gaiejj deleted the dev-docs branch June 23, 2023 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants