Skip to content

Conversation

@njzjz
Copy link
Member

@njzjz njzjz commented Nov 4, 2025

Signed-off-by: Jinzhe Zeng jinzhe.zeng@ustc.edu.cn

Summary by CodeRabbit

  • Documentation
    • Added a Credits section to README with citation details.
    • Enhanced project documentation with bibliographic citations.

njzjz and others added 2 commits November 4, 2025 16:11
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
@codecov
Copy link

codecov bot commented Nov 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.60%. Comparing base (4816095) to head (bd346ac).
⚠️ Report is 2 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (4816095) and HEAD (bd346ac). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (4816095) HEAD (bd346ac)
15 14
Additional details and impacted files
@@             Coverage Diff             @@
##           master     #555       +/-   ##
===========================================
- Coverage   60.40%   47.60%   -12.81%     
===========================================
  Files          39       39               
  Lines        3905     3905               
===========================================
- Hits         2359     1859      -500     
- Misses       1546     2046      +500     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 4, 2025

📝 Walkthrough

Walkthrough

Documentation updates across two files: a Credits section with citation information is added to README.md and a bibliographic entry for a DPDispatcher paper is added to doc/index.rst. Both represent pure documentation changes with no functional code modifications.

Changes

Cohort / File(s) Change Summary
Documentation Updates
README.md, doc/index.rst
Added citation and credits information; README includes new Credits section replacing References section, and doc/index.rst includes bibliographic entry for DPDispatcher paper

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Pure documentation changes with no code logic or functional modifications
  • Changes are additive/textual in nature with minimal risk of introducing issues

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add the citation' directly and clearly reflects the main changes in the pull request, which consist of adding citation blocks to documentation files (README.md and doc/index.rst).
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
doc/index.rst (1)

13-20: Add DOI reference to match README documentation.

The citation in doc/index.rst is incomplete compared to README.md—it omits the DOI link and citation badge. For consistency and to provide complete bibliographic information across all documentation entry points, add the DOI reference:

-  Fengbo Yuan, Zhaohan Ding, Yun-Pei Liu, Kai Cao, Jiahao Fan, Cao
-  Thang Nguyen, Yuzhi Zhang, Haidi Wang, Yixiao Chen, Jiameng Huang,
-  Tongqi Wen, Mingkang Liu, Yifan Li, Yong-Bin Zhuang, Hao Yu, Ping
-  Tuo, Yaotang Zhang, Yibo Wang, Linfeng Zhang, Han Wang, Jinzhe Zeng,
-  DPDispatcher: Scalable HPC Task Scheduling for AI-Driven Science, *J.
-  Chem. Inf. Model.*, 2025.
+  Fengbo Yuan, Zhaohan Ding, Yun-Pei Liu, Kai Cao, Jiahao Fan, Cao
+  Thang Nguyen, Yuzhi Zhang, Haidi Wang, Yixiao Chen, Jiameng Huang,
+  Tongqi Wen, Mingkang Liu, Yifan Li, Yong-Bin Zhuang, Hao Yu, Ping
+  Tuo, Yaotang Zhang, Yibo Wang, Linfeng Zhang, Han Wang, Jinzhe Zeng,
+  DPDispatcher: Scalable HPC Task Scheduling for AI-Driven Science, *J.
+  Chem. Inf. Model.*, 2025, DOI: `10.1021/acs.jcim.5c02081 <https://doi.org/10.1021/acs.jcim.5c02081>`_.

Consider also adding the DP-GEN origin note from README.md to provide fuller context in the documentation.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4816095 and bd346ac.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • doc/index.rst (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
doc/**/*.{rst,md}

📄 CodeRabbit inference engine (AGENTS.md)

Write documentation for Sphinx, using reStructuredText or MyST Markdown in doc/

Files:

  • doc/index.rst

@njzjz njzjz merged commit d949b5f into deepmodeling:master Nov 4, 2025
27 checks passed
@njzjz njzjz deleted the citation branch November 4, 2025 09:58
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.

1 participant