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 README, benchmarks and examples #246

Merged
merged 13 commits into from
May 27, 2023
Merged

Conversation

Gaiejj
Copy link
Member

@Gaiejj Gaiejj commented May 26, 2023

Description

Image title of off-policy benchmarks is wrong. This PR fix it.

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 26, 2023
zmsn-2077
zmsn-2077 previously approved these changes May 26, 2023
muchvo
muchvo previously approved these changes May 27, 2023
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 changed the title docs: fix image title docs: polish README, benchmarks and examples May 27, 2023
@codecov-commenter
Copy link

codecov-commenter commented May 27, 2023

Codecov Report

Merging #246 (75b76a9) into main (18776f1) will not change coverage.
The diff coverage is n/a.

❗ Current head 75b76a9 differs from pull request most recent head 746838d. Consider uploading reports for the commit 746838d 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     #246   +/-   ##
=======================================
  Coverage   97.01%   97.01%           
=======================================
  Files         138      138           
  Lines        6994     6994           
=======================================
  Hits         6785     6785           
  Misses        209      209           

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

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 48e326a into PKU-Alignment:main May 27, 2023
4 checks passed
@Gaiejj Gaiejj deleted the dev-off 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