Skip to content

Commit 6ddf11a

Browse files
author
Thierry RAMORASOAVINA
committed
Rename variable_part_dimensions to inner_variable_dimensions in Coclustering results
- `test_coclustering_results_simple_initializations` remains unchanged - the `CoclusteringDimension` docstring is amended to give more details on "Instances x Variables Coclustering"
1 parent 68f6798 commit 6ddf11a

File tree

2 files changed

+24
-15
lines changed

2 files changed

+24
-15
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
- Example: 10.2.1.4 is the 5th version that supports khiops 10.2.1.
77
- Internals: Changes in *Internals* sections are unlikely to be of interest for data scientists.
88

9+
## Unreleased
10+
11+
### Changed
12+
- (`core`) Rename `variable_part_dimensions` to `inner_variable_dimensions` in Coclustering results.
13+
914
## 11.0.0.3 - 2026-03-06
1015

1116
### Added

khiops/core/coclustering_results.py

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
|- cells -> list of CoclusteringCell
2424
2525
CoclusteringDimension
26-
|- parts -> list of CoclusteringDimensionPart
27-
|- variable_part_dimensions -> list of CoclusteringDimension
28-
|- clusters -> list of CoclusteringCluster
29-
|- root_cluster -> CoclusteringCluster
26+
|- parts -> list of CoclusteringDimensionPart
27+
|- inner_variable_dimensions -> list of CoclusteringDimension
28+
|- clusters -> list of CoclusteringCluster
29+
|- root_cluster -> CoclusteringCluster
3030
3131
CoclusteringDimensionPartValueGroup
3232
|- values -> list of CoclusteringDimensionPartValue
@@ -785,9 +785,13 @@ class CoclusteringDimension:
785785
Maximum value of a numerical dimension/variable.
786786
parts : list of `CoclusteringDimensionPart`
787787
Partition of this dimension.
788-
variable_part_dimensions : list of `CoclusteringDimension`
788+
inner_variable_dimensions : list of `CoclusteringDimension`
789789
Variable part instance-variable coclustering dimensions. ``None`` for
790790
variable-variable clustering.
791+
Contains the dimensions of the variables involved in the
792+
instances x variables coclustering model.
793+
This model includes two dimensions: one for instances and one for variable
794+
parts (`isVarPart` set to ``True`` for this dimension).
791795
clusters : list of `CoclusteringCluster`
792796
Clusters of this dimension's hierarchy. Note that includes intermediary
793797
clusters.
@@ -827,8 +831,8 @@ def __init__(self):
827831
# Clusters internal dictionary
828832
self._clusters_by_name = {}
829833

830-
# Variable part dimensions
831-
self.variable_part_dimensions = None
834+
# Inner variable dimensions
835+
self.inner_variable_dimensions = None
832836

833837
def init_summary(self, json_data=None):
834838
"""Initializes the summary attributes from a Python JSON object
@@ -954,7 +958,7 @@ def init_partition(self, json_data=None):
954958
# Create inner variables dimensions (subpartition)
955959
if "innerVariables" not in json_data:
956960
raise KhiopsJSONError("'innerVariables' key not found")
957-
self.variable_part_dimensions = []
961+
self.inner_variable_dimensions = []
958962
json_inner_variables = json_data["innerVariables"]
959963
if "dimensionSummaries" in json_inner_variables:
960964
for json_dimension_summary in json_inner_variables[
@@ -963,25 +967,25 @@ def init_partition(self, json_data=None):
963967
dimension = CoclusteringDimension().init_summary(
964968
json_dimension_summary
965969
)
966-
self.variable_part_dimensions.append(dimension)
970+
self.inner_variable_dimensions.append(dimension)
967971

968972
# Initialize inner variables dimensions' partitions
969973
if "dimensionPartitions" in json_inner_variables:
970974
json_dimension_partitions = json_inner_variables[
971975
"dimensionPartitions"
972976
]
973-
if len(self.variable_part_dimensions) != len(
977+
if len(self.inner_variable_dimensions) != len(
974978
json_dimension_partitions
975979
):
976980
raise KhiopsJSONError(
977-
"'ineerVariables/dimensionPartitions' list has length "
981+
"'innerVariables/dimensionPartitions' list has length "
978982
f"{len(json_dimension_partitions)} instead of "
979-
f"{len(self.variable_part_dimensions)}"
983+
f"{len(self.inner_variable_dimensions)}"
980984
)
981985
for i, json_dimension_partition in enumerate(
982986
json_dimension_partitions
983987
):
984-
dimension = self.variable_part_dimensions[i]
988+
dimension = self.inner_variable_dimensions[i]
985989
dimension.init_partition(json_dimension_partition)
986990

987991
return self
@@ -1137,11 +1141,11 @@ def to_dict(self, report_type):
11371141
report["innerVariables"] = {
11381142
"dimensionSummaries": [
11391143
dimension.to_dict(report_type="summary")
1140-
for dimension in self.variable_part_dimensions
1144+
for dimension in self.inner_variable_dimensions
11411145
],
11421146
"dimensionPartitions": [
11431147
dimension.to_dict(report_type="partition")
1144-
for dimension in self.variable_part_dimensions
1148+
for dimension in self.inner_variable_dimensions
11451149
],
11461150
}
11471151
return report

0 commit comments

Comments
 (0)