dislib
dislib copied to clipboard
Standarize nomenclature
Standarize nomenclature in the source code and documentation according to:
-
dislib.Arrayinstances are referred to asds-array. - NumPy array instances are referred to as
ndarray. -
xandyshould be used fords-arraysrepresenting samples and target values. -
x_npandy_npshould be used forndarraysrepresenting samples and target values. - A NumPy array or
csr_matrixthat is a part of ads-arrayshould be namedblock. - When iterating
ds-arrayshorizontally and vertically,hblockandvblockshould be used to refer to sets ofblocks. - Tasks that receive a set of blocks as input parameter should name this parameter
blocks. - In the documentation, variable
xshould be described as 'Training samples'. - In the documentation, variable
yshould 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.pyfile 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)