assume-framework / assume

ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution
https://assume.readthedocs.io
22 stars 5 forks source link

Tutorial 02 #259

Closed nick-harder closed 8 months ago

nick-harder commented 9 months ago

This commit adds the new example. It also edits multiple docstring transitioning to the google style docstings. The whole common folder has been edited. Tests have been also slightly modified, purely cosmetical changes where all marketconfigs have now parameter_name=parameter for easier reading.

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (dd9a744) 78.45% compared to head (0c9d45d) 78.49%. Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #259 +/- ## ========================================== + Coverage 78.45% 78.49% +0.04% ========================================== Files 39 39 Lines 4260 4260 ========================================== + Hits 3342 3344 +2 + Misses 918 916 -2 ``` | [Flag](https://app.codecov.io/gh/assume-framework/assume/pull/259/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | Coverage Δ | | |---|---|---| | [pytest](https://app.codecov.io/gh/assume-framework/assume/pull/259/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | `78.49% <100.00%> (+0.04%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

maurerle commented 8 months ago

It does not look good at all. The new doc style is so broken.

https://assume.readthedocs.io/en/latest/assume.common.html#assume.common.forecasts.CsvForecaster.calculate_residual_demand_forecast

maurerle commented 8 months ago

This is how it should look like: image

This is how the GPT-docs style shows up: image

We can merge this as usual and fix it afterwards. I don't think that there is an automated way to parse the GPT docs suggestions and fix them.