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

Clarify the logger message of BirchClustering #604

Merged
merged 4 commits into from
Apr 1, 2024

Conversation

JiQi535
Copy link
Collaborator

@JiQi535 JiQi535 commented Apr 1, 2024

Summary

Clarify the logger message of BirchClustering. When n is set not to an integer instead of None, the number of clusters returned by BIRCH is actually equal to n, instead of the number of clusters dependent on threshold. This is discussed in details on the documentation of sklearn for BIRCH, when n_clusters is an integer or None.

Checklist

  • Google format doc strings added. Check with ruff.
  • Type annotations included. Check with mypy.
  • Tests added for new features/fixes.
  • If applicable, new classes/functions/modules have duecredit @due.dcite decorators to reference relevant papers by DOI (example)

Tip: Install pre-commit hooks to auto-check types and linting before every commit:

pip install -U pre-commit
pre-commit install

Copy link

codecov bot commented Apr 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.58%. Comparing base (2c1bf6a) to head (56a5505).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #604      +/-   ##
==========================================
- Coverage   67.64%   67.58%   -0.06%     
==========================================
  Files          68       68              
  Lines        5263     5263              
==========================================
- Hits         3560     3557       -3     
- Misses       1703     1706       +3     

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

@shyuep shyuep merged commit c522b48 into materialsvirtuallab:master Apr 1, 2024
5 of 7 checks passed
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.

2 participants