Open tommyod opened 1 year ago
I propose:
parameters
, responses
, covariance
, observations
is quite good, instead of the ensemble
-suffix and the shortenings param
instead of parameters
. However, the similarity between a response
and an observation
might confusing.num_parameters
, num_responses
and num_ensemble
, using the num_
prefix for all shapes.We could add some checks in the CI/CD pipeline that fail if any common misspellings are used, so we do not regress in the future.
We should decide what we call parameters.
response_ensemble
vs.Y
vs.responses
observation_errors
vs.C_dd
param_ensemble
vs.X
vs.parameters
Shapes
num_obs
vs.num_observations
vs.num_outputs
ensemble_size
vs.num_ensemble
vs.N_e
vs.N
We can use different names for the public API and the internals.
If we decide on this now, it will save us time and headache in the future.