Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decide on nomenclature #129

Open
tommyod opened this issue Aug 11, 2023 · 1 comment
Open

Decide on nomenclature #129

tommyod opened this issue Aug 11, 2023 · 1 comment

Comments

@tommyod
Copy link
Collaborator

tommyod commented Aug 11, 2023

We should decide what we call parameters.

  • response_ensemble vs. Y vs. responses
  • observation_errors vs. C_dd
  • param_ensemble vs. X vs. parameters
  • etc

Shapes

  • num_obs vs. num_observations vs. num_outputs
  • ensemble_size vs. num_ensemble vs. N_e vs. N
  • etc

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.

@tommyod
Copy link
Collaborator Author

tommyod commented Aug 11, 2023

I propose:

  • The public API should be consistent across all algorithms. I think 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.
  • The internal variable names. I propose that we rename all input arguments immediately to mathematical notation that corresponds with the paper, and follow that in all the internals (non-public facing API).
  • For shapes, I propose 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.

@eivindjahren eivindjahren added christmas-review Issues and PRs for Christmas review and removed christmas-review Issues and PRs for Christmas review labels Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants