Skip to content

Commit 8ef967d

Browse files
committed
fix docstrings
1 parent e63cecc commit 8ef967d

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

torch_geometric/datasets/graphland.py

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,42 +56,53 @@ class GraphLandDataset(InMemoryDataset):
5656
numerical_features_transform (str, optional): A transform applied to
5757
numerical features (:obj:`None`, :obj:`"standard_scaler"`,
5858
:obj:`"min_max_scaler"`, :obj:`"quantile_transform_normal"`,
59-
:obj:`"quantile_transform_uniform"`). Since numerical features can
60-
have widely different scales and distributions, it is typically
61-
useful to apply some transform to them before passing them to a
62-
neural model. This transform is applied to all numerical features
63-
except for those that are also categorized as fraction features.
64-
(default :obj:`"quantile_transform_normal"`)
59+
:obj:`"quantile_transform_uniform"`, :obj:`"default"`).
60+
Since numerical features can have widely different scales and
61+
distributions, it is typically useful to apply some transform
62+
to them before passing them to a neural model. This transform
63+
is applied to all numerical features except for those that are
64+
also categorized as fraction features. The :obj:`"default"` value
65+
selects a dataset-specific transform from the other options that
66+
was determined to be a safe and likely optimal choice for this
67+
dataset based on experiments with various GNNs.
68+
(default: :obj:`"default"`)
6569
fraction_features_transform (str, optional): A transform applied to
6670
fraction features (:obj:`None`, :obj:`"standard_scaler"`,
6771
:obj:`"min_max_scaler"`, :obj:`"quantile_transform_normal"`,
68-
:obj:`"quantile_transform_uniform"`). Fraction features are a
69-
subset of numerical features that have the meaning of fractions
70-
and are thus always in :obj:`[0, 1]` range. Since their range is
71-
bounded, it is not neccessary but may still be useful to apply
72-
some transform to them before passing them to a neural model.
73-
(default :obj:`None`)
72+
:obj:`"quantile_transform_uniform"`, :obj:`"default"`). Fraction
73+
features are a subset of numerical features that have the meaning
74+
of fractions and are thus always in :obj:`[0, 1]` range. Since
75+
their range is bounded, it is not neccessary but may still be
76+
useful to apply some transform to them before passing them to a
77+
neural model. The :obj:`"default"` value selects a dataset-specific
78+
transform from the other options that was determined to be a safe
79+
and likely optimal choice for this dataset based on experiments
80+
with various GNNs. (default: :obj:`"default"`)
7481
categorical_features_transform (str, optional): A transform applied to
7582
categorical features (:obj:`None`, :obj:`"one_hot_encoding"`).
7683
It is most often useful to apply one-hot encoding to categorical
7784
features before passing them to a neural model.
78-
(default :obj:`one_hot_encoding`)
85+
(default: :obj:`"one_hot_encoding"`)
7986
regression_targets_transform (str, optional): A transform applied to
8087
regression targets (:obj:`None`, :obj:`"standard_scaler"`,
81-
:obj:`"min_max_scaler"`). Depending on their range, it may or may
82-
not be useful to apply a transform to regression targets before
83-
fitting a neural model to them. This argument does not affect
84-
classification datasets. (default :obj:`"standard_scaler"`)
88+
:obj:`"min_max_scaler"`, :obj:`"default"`). Depending on their
89+
range, it may or may not be useful to apply a transform to
90+
regression targets before fitting a neural model to them.
91+
The :obj:`"default"` value selects a dataset-specific transform
92+
from the other options that was determined to be a safe and likely
93+
optimal choice for this dataset based on experiments with various
94+
GNNs. This argument does not affect classification datasets.
95+
(default: :obj:`"default"`)
8596
numerical_features_nan_imputation_strategy (str, optional): Defines
8697
which value to fill NaNs in numerical features with
8798
(:obj:`None`, :obj:`"mean"`, :obj:`"median"`,
8899
:obj:`"most_frequent"`). This imputation strategy is applied to
89100
all numerical features except for those that are also categorized
90-
as fraction features. (default :obj:`"most_frequent"`)
101+
as fraction features. (default: :obj:`"most_frequent"`)
91102
fraction_features_nan_imputation_strategy (str, optional): Defines
92103
which value to fill NaNs in fraction features with (:obj:`None`,
93104
:obj:`"mean"`, :obj:`"median"`, :obj:`"most_frequent"`).
94-
(default :obj:`"most_frequent"`)
105+
(default: :obj:`"most_frequent"`)
95106
to_undirected (bool, optional): Whether to convert a directed graph
96107
to an undirected one. Does not affect undirected graphs.
97108
(default: :obj:`False`)

0 commit comments

Comments
 (0)