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

Fix: Modify docs of DPA models #4510

Merged
merged 1 commit into from
Dec 26, 2024

Conversation

QuantumMisaka
Copy link

@QuantumMisaka QuantumMisaka commented Dec 26, 2024

Modify docs of DPA models, especially for DPA-1 website

Summary by CodeRabbit

  • Documentation
    • Updated DPA-2 model documentation for improved clarity and accessibility.
    • Changed references in the "se_atten" descriptor documentation to link to a formal publication on Nature.
    • Revised citations in the fine-tuning documentation to point to the DPA-1 paper on Nature, enhancing the credibility of sources.

@github-actions github-actions bot added the Docs label Dec 26, 2024
Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

📝 Walkthrough

Walkthrough

This pull request involves updating documentation references for the DPA-2 and DPA-1 models across multiple markdown files. The primary changes include replacing arXiv paper links with more recent Nature publication links. These updates are focused on improving citation accuracy and readability, particularly for the DPA-2 and DPA-1 model documentation. No substantive changes to the technical content or structure of the documents were made.

Changes

File Change Summary
doc/model/dpa2.md Reformatted paper URL from plain text to markdown link for DPA-2 paper
doc/model/train-se-atten.md Updated DPA-1 paper references from arXiv to Nature publication links
doc/train/finetuning.md Updated DPA-1 paper references from arXiv to Nature publication links

Possibly related PRs

Suggested labels

Docs

Suggested reviewers

  • njzjz
  • wanghan-iapcm

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3cecca4 and 214bd9b.

📒 Files selected for processing (3)
  • doc/model/dpa2.md (1 hunks)
  • doc/model/train-se-atten.md (2 hunks)
  • doc/train/finetuning.md (2 hunks)
✅ Files skipped from review due to trivial changes (3)
  • doc/train/finetuning.md
  • doc/model/dpa2.md
  • doc/model/train-se-atten.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Dec 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.59%. Comparing base (3cecca4) to head (214bd9b).
Report is 3 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4510   +/-   ##
=======================================
  Coverage   84.59%   84.59%           
=======================================
  Files         675      675           
  Lines       63575    63574    -1     
  Branches     3486     3487    +1     
=======================================
  Hits        53779    53779           
+ Misses       8671     8670    -1     
  Partials     1125     1125           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Dec 26, 2024
Merged via the queue into deepmodeling:devel with commit ff9b75e Dec 26, 2024
60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants