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: update readme #1483

Merged
merged 9 commits into from
Jan 10, 2025
Merged

docs: update readme #1483

merged 9 commits into from
Jan 10, 2025

Conversation

myhloli
Copy link
Collaborator

@myhloli myhloli commented Jan 10, 2025

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Please describe the motivation of this PR and the goal you want to achieve through this PR.

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the backward compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here and update the documentation.

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects.
  • CLA has been signed and all committers have signed the CLA in this PR.

myhloli and others added 9 commits January 10, 2025 14:38
- Correct the release date for version 1.0.0 in both English and Chinese README files
- Ensure consistency across documentation for the official release
fix(docs): update pip install command in README files
- Add MPS support for Apple Silicon devices
- Implement empty_cache() for MPS devices
- Set PYTORCH_ENABLE_MPS_FALLBACK environment variable
- Adjust MFR model device allocation for MPS
fix(device): enable MPS support and fix related issues
- Added information about MPS acceleration support for Apple silicon chips- Updated README files to include MPS-related content and configuration instructions
- Improved language and formatting consistency across both English and Chinese README files
- Simplify and clarify the description of MinerU Desktop
- Make the language more inviting and straightforward for users
feat(README): add MPS acceleration support for Apple silicon
@myhloli myhloli merged commit 1c9f994 into release-1.0.0 Jan 10, 2025
1 check passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants