Skip to content

fix: statisitcs -> statistics#5315

Merged
wanghan-iapcm merged 2 commits intodeepmodeling:masterfrom
kmu:typos
Mar 16, 2026
Merged

fix: statisitcs -> statistics#5315
wanghan-iapcm merged 2 commits intodeepmodeling:masterfrom
kmu:typos

Conversation

@kmu
Copy link
Contributor

@kmu kmu commented Mar 16, 2026

This PR fixes a typo pattern.

Summary by CodeRabbit

  • Documentation
    • Fixed multiple typos and wording in method docstrings and parameter descriptions (e.g., corrected "statisitcs" → "statistics", "Reveive" → "Receive", and similar inconsistencies). These edits improve clarity and consistency of technical documentation without changing behavior, interfaces, or functionality.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 16, 2026

📝 Walkthrough

Walkthrough

This PR corrects typographical errors in docstrings across descriptor modules (dpmodel, pd, pt, tf), mainly changing "statisitcs"/"statistitcs" to "statistics" and small wording fixes. No functional, signature, or control-flow changes were made.

Changes

Cohort / File(s) Summary
DPModel Descriptor
deepmd/dpmodel/descriptor/hybrid.py, deepmd/dpmodel/descriptor/make_base_descriptor.py
Fixed docstring typos in enable_compression (e.g., "statisitcs" → "statistics").
PD Model Descriptor
deepmd/pd/model/descriptor/dpa1.py, deepmd/pd/model/descriptor/se_a.py
Corrected "statisitcs" → "statistics" in enable_compression docstrings.
PT Model Descriptor
deepmd/pt/model/descriptor/dpa1.py, deepmd/pt/model/descriptor/hybrid.py, deepmd/pt/model/descriptor/se_a.py, deepmd/pt/model/descriptor/se_r.py, deepmd/pt/model/descriptor/se_t.py
Fixed misspellings in enable_compression docstrings (e.g., "statisitcs"/"statistitcs" → "statistics").
TF Descriptor - Core & Hybrid
deepmd/tf/descriptor/descriptor.py, deepmd/tf/descriptor/hybrid.py
Corrected typos in compute_input_stats, merge_input_stats, and enable_compression docstrings ("statisitcs" → "statistics").
TF Descriptor - SE Variants
deepmd/tf/descriptor/loc_frame.py, deepmd/tf/descriptor/se_a.py, deepmd/tf/descriptor/se_a_ef.py, deepmd/tf/descriptor/se_a_mask.py, deepmd/tf/descriptor/se_atten.py, deepmd/tf/descriptor/se_r.py, deepmd/tf/descriptor/se_t.py
Various docstring corrections across compute_input_stats, merge_input_stats, and enable_compression (e.g., "statisitcs"/"Reveive" → "statistics"/"Receive").

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

Docs

Suggested reviewers

  • njzjz
  • wanghan-iapcm
  • iProzd
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Title check ✅ Passed The title 'fix: statisitcs -> statistics' clearly and accurately describes the main change: correcting a widespread typo pattern across multiple files in docstrings.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

You can customize the high-level summary generated by CodeRabbit.

Configure the reviews.high_level_summary_instructions setting to provide custom instructions for generating the high-level summary.

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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@deepmd/tf/descriptor/hybrid.py`:
- Line 147: Rename the function parameter currently named "list" in hybrid.py
(the function starting near the top where that arg is declared) to avoid
shadowing the builtin (e.g., rename to "item_list" or "entries") and update all
internal references; in hybrid.py also rename the unused loop variable "idx" to
"_idx" where it appears around the loop near line 360. In se_r.py replace
mutable default arguments at the function(s) around lines 99 and 104 by using
None as the default and initialize the lists inside the function (e.g., if param
is None: param = [24,48,96] or param = []), and for the unpacked but unused
variables descrpt_deriv, rij, nlist around line 192 prefix them with an
underscore (e.g., _descrpt_deriv, _rij, _nlist) to silence the RUF059 warning.

In `@deepmd/tf/descriptor/se_atten.py`:
- Line 2365: Update the misspelled word in the docstring inside
deepmd/tf/descriptor/se_atten.py where the text currently reads "Reveive the
statistics (distance, max_nbor_size and env_mat_range) of the training data." —
change "Reveive" to "Receive" in that docstring so it reads "Receive the
statistics (distance, max_nbor_size and env_mat_range) of the training data."
Reference the docstring text to locate the exact spot to edit.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 0bcaa38a-c3fd-47c5-a96f-6766ba57ef4f

📥 Commits

Reviewing files that changed from the base of the PR and between 09345bf and d14fa16.

📒 Files selected for processing (18)
  • deepmd/dpmodel/descriptor/hybrid.py
  • deepmd/dpmodel/descriptor/make_base_descriptor.py
  • deepmd/pd/model/descriptor/dpa1.py
  • deepmd/pd/model/descriptor/se_a.py
  • deepmd/pt/model/descriptor/dpa1.py
  • deepmd/pt/model/descriptor/hybrid.py
  • deepmd/pt/model/descriptor/se_a.py
  • deepmd/pt/model/descriptor/se_r.py
  • deepmd/pt/model/descriptor/se_t.py
  • deepmd/tf/descriptor/descriptor.py
  • deepmd/tf/descriptor/hybrid.py
  • deepmd/tf/descriptor/loc_frame.py
  • deepmd/tf/descriptor/se_a.py
  • deepmd/tf/descriptor/se_a_ef.py
  • deepmd/tf/descriptor/se_a_mask.py
  • deepmd/tf/descriptor/se_atten.py
  • deepmd/tf/descriptor/se_r.py
  • deepmd/tf/descriptor/se_t.py

@codecov
Copy link

codecov bot commented Mar 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.30%. Comparing base (09345bf) to head (e1bb5b0).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5315   +/-   ##
=======================================
  Coverage   82.29%   82.30%           
=======================================
  Files         775      775           
  Lines       77627    77627           
  Branches     3676     3675    -1     
=======================================
+ Hits        63887    63888    +1     
  Misses      12566    12566           
+ Partials     1174     1173    -1     

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@wanghan-iapcm wanghan-iapcm changed the title statisitcs -> statistics fix: statisitcs -> statistics Mar 16, 2026
@wanghan-iapcm wanghan-iapcm enabled auto-merge March 16, 2026 11:34
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Mar 16, 2026
Merged via the queue into deepmodeling:master with commit 4ce5c73 Mar 16, 2026
70 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