Skip to content

docs: finish cluster_weights->cluster_counts terminology cleanup #107

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.

Sign up for GitHub

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

Merged
FBumann merged 1 commit into from
Jul 23, 2026
Merged

docs: finish cluster_weights->cluster_counts terminology cleanup #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/examples/getting-started.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@
"source": [
"print(f\"Clusters: {result.n_clusters}\")\n",
"print(f\"Timesteps per period: {result.n_timesteps_per_period}\")\n",
"print(\"Cluster weights (days each represents):\")\n",
"result.cluster_counts.to_dataframe(\"weight\")"
"print(\"Cluster counts (days each represents):\")\n",
"result.cluster_counts.to_dataframe(\"count\")"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/multi-dim.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
"coherent multi-dimensional arrays.\n",
"\n",
"Here, `scenario` is auto-sliced. Each scenario gets its own clustering.\n",
"Cluster weights, accuracy metrics, and cluster representatives all have the `scenario`\n",
"Cluster counts, accuracy metrics, and cluster representatives all have the `scenario`\n",
"dimension — no manual looping or concatenation needed.\n",
"\n",
"Without tsam_xarray, you'd have to:\n",
Expand Down Expand Up @@ -115,7 +115,7 @@
" n_clusters=4,\n",
")\n",
"print(\"Result dims:\", result_sliced.cluster_representatives.dims)\n",
"result_sliced.cluster_counts.to_dataframe(\"weight\")"
"result_sliced.cluster_counts.to_dataframe(\"count\")"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion test/test_parametrized.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ def test_cluster_occurrences_dims(self, agg_case: AggregateCase):
da = result.clustering.cluster_occurrences
assert set(da.dims) == {"cluster"} | agg_case.expected_slice_dims

def test_cluster_occurrences_matches_weights(self, agg_case: AggregateCase):
def test_cluster_occurrences_matches_counts(self, agg_case: AggregateCase):
"""Occurrences match AggregationResult.cluster_counts."""
result = _aggregate(agg_case)
np.testing.assert_array_equal(
Expand Down
Loading