Skip to content

Commit eaa12e5

Browse files
committed
docstrings udpdates
1 parent 3e21f7f commit eaa12e5

1 file changed

Lines changed: 4 additions & 11 deletions

File tree

src/graphnet/models/graphs/utils.py

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,6 @@ def __init__(self, x: np.ndarray, cluster_columns: List[int]) -> None:
209209
x: Array to be clustered
210210
cluster_columns: List of column indices on which the clusters
211211
are constructed.
212-
Returns: None
213212
Adds:
214213
clustered_x: Added to the class
215214
_counts: Added to the class
@@ -252,9 +251,10 @@ def _add_column(
252251
253252
Args:
254253
column: Column to be added to the tensor
255-
location: Location to insert the column in the clustered tensor
256-
Returns:
257-
clustered_x: The clustered tensor with the column added
254+
location: Location to insert the column in the clustered tensor.
255+
Altered:
256+
clustered_x: The column is added at the end of the tenor or
257+
inserted at the specified location
258258
"""
259259
if location is None:
260260
self.clustered_x = np.column_stack([self.clustered_x, column])
@@ -302,9 +302,6 @@ def add_charge_threshold_summary(
302302
charge_index: index of the charge column in the padded tensor
303303
location: Location to insert the summarization indices in the
304304
clustered tensor defaults to adding at the end
305-
Returns:
306-
clustered_x: The clustered tensor with the summarization indices
307-
added
308305
Adds:
309306
_charge_sum: Added to the class
310307
_charge_weights: Added to the class
@@ -359,10 +356,6 @@ def add_percentile_summary(
359356
method: Method to summarize the features. E.g. "linear"
360357
location: Location to insert the summarization indices in the
361358
clustered tensor defaults to adding at the end
362-
Returns:
363-
None
364-
Adds:
365-
None
366359
Altered:
367360
clustered_x: The summarization indices are added at the end of
368361
the tensor or inserted at the specified location

0 commit comments

Comments
 (0)