Skip to content

Conversation

@sgreenbury
Copy link
Collaborator

@sgreenbury sgreenbury commented Jul 29, 2025

Closes #555 and contributes towards #467 (merge after #652)

This PR:

  • Adds documentation lint to ruff config with numpy pydocstyle
  • Adds, extends and updates docstrings

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@sgreenbury sgreenbury changed the base branch from main to 646-rename-emulators July 29, 2025 12:45
@sgreenbury sgreenbury self-assigned this Jul 29, 2025
@sgreenbury sgreenbury changed the title Add docstring lint config Add docs lint config and update docstrings Jul 29, 2025
@sgreenbury sgreenbury force-pushed the 646-rename-emulators branch from fabd307 to c450962 Compare July 29, 2025 13:51
Copy link
Member

@radka-j radka-j left a comment

Choose a reason for hiding this comment

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

This is absolutely amazing, thank you so much for doing all this! As discussed, we just need to update it so that there is consistency in how we specify defaults in docstrings.

Co-authored-by: Radka Jersakova <[email protected]>
sgreenbury and others added 4 commits July 30, 2025 14:08
Co-authored-by: Radka Jersakova <[email protected]>
Co-authored-by: Radka Jersakova <[email protected]>
Co-authored-by: Radka Jersakova <[email protected]>
Co-authored-by: Radka Jersakova <[email protected]>
@sgreenbury sgreenbury changed the base branch from 646-rename-emulators to main July 30, 2025 13:17
@sgreenbury sgreenbury merged commit 1f3dc2e into main Jul 30, 2025
3 checks passed
@github-project-automation github-project-automation bot moved this to ✅ Done in AutoEmulate Jul 30, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Jul 30, 2025

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  autoemulate/experimental
  compare.py 566
  results.py
  save.py
  sensitivity_analysis.py 72-73, 675
  tuner.py
  autoemulate/experimental/callbacks
  early_stopping.py 70-72, 77
  autoemulate/experimental/data
  utils.py 130
  autoemulate/experimental/emulators
  base.py 87, 105-106
  ensemble.py 63, 68, 247
  lightgbm.py
  polynomials.py 95
  random_forest.py
  svm.py
  autoemulate/experimental/emulators/gaussian_process
  exact.py
  kernel.py
  autoemulate/experimental/emulators/nn
  mlp.py
  autoemulate/experimental/learners
  base.py
  autoemulate/experimental/simulations
  experimental_design.py
  projectile.py
  autoemulate/experimental/transforms
  base.py 191-192
  tests
  test_compare.py
  tests/experimental
  test_experimental_bayesian_calibration.py
  test_experimental_gaussian_process_exact.py
  test_experimental_history_matching.py
  test_learners.py 35-56
Project Total  

The report is truncated to 25 files out of 54. To see the full report, please visit the workflow summary page.

This report was generated by python-coverage-comment-action

@codecov-commenter
Copy link

Codecov Report

❌ Patch coverage is 87.50000% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.21%. Comparing base (5075324) to head (5e2b8dc).
⚠️ Report is 18 commits behind head on main.

Files with missing lines Patch % Lines
...xperimental/emulators/gaussian_process/__init__.py 50.00% 2 Missing ⚠️
...perimental/emulators/gaussian_process/poly_mean.py 0.00% 1 Missing ⚠️
autoemulate/experimental/transforms/base.py 50.00% 1 Missing ⚠️
autoemulate/experimental/transforms/pca.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #663      +/-   ##
==========================================
- Coverage   80.22%   80.21%   -0.01%     
==========================================
  Files         154      154              
  Lines       11153    11161       +8     
==========================================
+ Hits         8947     8953       +6     
- Misses       2206     2208       +2     

☔ 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.

@sgreenbury sgreenbury deleted the 467-update-docs branch July 30, 2025 14:47
@sgreenbury sgreenbury mentioned this pull request Jul 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Refactor: docstring style and ruff config

4 participants