Skip to content

update axis naming args#95

Merged
frazane merged 3 commits intofrazane:docufrom
nicholasloveday:docu
Apr 7, 2025
Merged

update axis naming args#95
frazane merged 3 commits intofrazane:docufrom
nicholasloveday:docu

Conversation

@nicholasloveday
Copy link
Contributor

I have gone with
m_axis = ensemble member axis
v_axis = variable axis
k_axis = discrete category axis
mc_axis = mixture components axis

@nicholasloveday
Copy link
Contributor Author

nicholasloveday commented Apr 7, 2025

@frazane I have made some updates and it is ready for you to look at. I had trouble setting up the env to work on my machine, but the tests are passing here https://github.com/nicholasloveday/scoringrules/actions/runs/14297512923

Copy link
Owner

@frazane frazane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :) thank you!

@frazane frazane merged commit 7f4603f into frazane:docu Apr 7, 2025
frazane added a commit that referenced this pull request May 30, 2025
* add theory documentation

* add readthedocs config

* add readthedocs files

* delete obsolete files

* update gitignore

* update docs requirements

* use docs requirements file

* update docs requirements

* update docs requirements

* misc fixes and test cross-references

* remove old file from index

* install the local package code for the build

* expand API reference documentation

* delete mkdocs config file

* wip on crps docstrings

* more wip on crps docstrings

* pass doctest for examples in _crps.py

* more work on docstrings - math blocks, args, formatting, etc.

* add examples and pass doctest for variogram scores

* comment out latex math hook

* update theory docs

* add documentation page for ensemble forecasts

* add documentation page for ensemble forecasts

* add documentation page for weighted scoring rules

* update docu index

* update axis naming args (#95)

* change ens member axis to m_axis

* change categorical axis to k_axis

* update mixture components axis name

* fix m_axis bug

* change test_kernels to use m_axis argument

* fix m_axis bug in logs_ensemble

* increase N in crps ensemble tests

* add exception in crps ensemble tests for akr approximations

* change energy score function name

* change variogram score function name

* add default threshold arguments to twcrps_ensemble

* add default threshold arguments to owcrps_ensemble

* add default threshold arguments to vrcrps_ensemble

* reduce tolerance on owgksuv_ensemble test

* add default threshold argument to weighted gksuv scores

* update default w_func in vrcrps_ensemble

* update test_wcrps

* reduce tolerance of owgks tests

* reduce tolerance of owgks tests

* update documentation link and prepare release tag

* add deprecated aliases

* more minor fixes

---------

Co-authored-by: sallen12 <sam.allen@stat.unibe.ch>
Co-authored-by: Nicholas Loveday <48701367+nicholasloveday@users.noreply.github.com>
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

Successfully merging this pull request may close these issues.

2 participants