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 #231

Merged
merged 42 commits into from
May 10, 2023
Merged

docs: polish readme #231

merged 42 commits into from
May 10, 2023

Conversation

zmsn-2077
Copy link
Member

@zmsn-2077 zmsn-2077 commented May 4, 2023

Description

Preview in: https://github.com/zmsn-2077/omnisafe_zmsn/tree/dev-readme

Motivation and Context

Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax close #15213 if this solves the issue #15213

  • I have raised an issue to propose this change (required for new features and bug fixes)

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)

Copy link
Member

@XuehaiPan XuehaiPan left a comment

Choose a reason for hiding this comment

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

Could you elaborate why we need emoji in documentation?

@zmsn-2077
Copy link
Member Author

Could you elaborate why we need emoji in documentation?

All changes were made to make reading more concise, the current README was too redundant and I reduced some of the table of contents and content through <details>. Adding emoji is more of a reference to DeepSpeedChat: https://github.com/microsoft/DeepSpeedExamples/tree/master/applications/DeepSpeed-Chat. During reading, emoji can make the directory structure is now clear.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
zmsn-2077 and others added 5 commits May 9, 2023 21:55
Co-authored-by: muchvo <118189931+muchvo@users.noreply.github.com>
Co-authored-by: muchvo <118189931+muchvo@users.noreply.github.com>
Co-authored-by: muchvo <118189931+muchvo@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
zmsn-2077 and others added 7 commits May 9, 2023 23:14
@XuehaiPan XuehaiPan changed the title docs: polish readme and add emoji docs: polish readme May 9, 2023
Copy link
Member

@Gaiejj Gaiejj left a comment

Choose a reason for hiding this comment

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

The organization badge is still PKU-MARL. What about transfer it to OmniSafeAI.

@zmsn-2077
Copy link
Member Author

The organization badge is still PKU-MARL. What about transfer it to OmniSafeAI.

Already update.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
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.

@zmsn-2077 zmsn-2077 merged commit 644cd25 into PKU-Alignment:dev May 10, 2023
@zmsn-2077 zmsn-2077 deleted the dev-readme branch May 10, 2023 16:28
@zmsn-2077 zmsn-2077 restored the dev-readme branch May 10, 2023 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants