CostModels provides a small collection of cost models built using JAX and can provide gradients of finantial metrics with respect to arbitrary design variables. The package is under active development and the API may change without notice.
Available models can be found in src/costmodels/models directory. And examples folder contains some common use cases of the package.
- Stable PyPi
pip install costmodels- Source
pip install -e .- Development
pip install -e .[test]Installation requires pixi binary that can be obtained from https://pixi.sh/latest/#installation;
# development environment install & activation (equivalent to `conda activate`)
pixi shell
# pre-commit formatting hooks (run only once)
pre-commit install
# run tests
pytest