You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Standarize nomenclature in the source code and documentation according to:
dislib.Array instances are referred to as ds-array.
NumPy array instances are referred to as ndarray.
x and y should be used for ds-arrays representing samples and target values.
x_np and y_np should be used for ndarrays representing samples and target values.
A NumPy array or csr_matrix that is a part of a ds-array should be named block.
When iterating ds-arrays horizontally and vertically, hblock and vblock should be used to refer to sets of blocks.
Tasks that receive a set of blocks as input parameter should name this parameter blocks.
In the documentation, variable x should be described as 'Training samples'.
In the documentation, variable y should be described as 'Target values'.
Optional arguments should be documented in the formula: "int, optional (default=0)"
Input ds-arrays should be documented with the formula: "ds-array, shape=(n_samples, n_features)"
The name of functions that are tasks should start with _.
The name of files and functions that are not supposed to be accessed by users should start with _.
Estimators need to be implemented in a base.py file in a separate sub-folder inside the appropriate submodule. Additional files can be included in the same subfolder named with a leading _.
Other typical variable names:
number of something = n_something
max_iter
arity
tol = tolerance criteria
random_state
verbose
check_convergence (whether to check for convergence)
The text was updated successfully, but these errors were encountered:
Standarize nomenclature in the source code and documentation according to:
dislib.Array
instances are referred to asds-array
.ndarray
.x
andy
should be used fords-arrays
representing samples and target values.x_np
andy_np
should be used forndarrays
representing samples and target values.csr_matrix
that is a part of ads-array
should be namedblock
.ds-arrays
horizontally and vertically,hblock
andvblock
should be used to refer to sets ofblocks
.blocks
.x
should be described as 'Training samples'.y
should be described as 'Target values'._
._
.base.py
file in a separate sub-folder inside the appropriate submodule. Additional files can be included in the same subfolder named with a leading_
.The text was updated successfully, but these errors were encountered: