search

ActivitySim / activitysim

An Open Platform for Activity-Based Travel Modeling
https://activitysim.github.io
BSD 3-Clause "New" or "Revised" License
194 stars 99 forks source link

Shadow Pricing Size Term Results Missing #433

Closed danielsclint closed 3 years ago

danielsclint commented 3 years ago

When I run the ARC example with Shadow Pricing (use_shadow_pricing: True), no shadow price results seem to be exported from the model. I see trace files from each iteration.

Also, is there an example of how to specify the shadow prices as an input into the model, so we don't need to run shadow_pricing every model run?

bstabler commented 3 years ago

@danielsclint to investigate, thanks Clint

danielsclint commented 3 years ago

Warm Start Shadow Pricing

The code does have a spot where shadow prices are read into the model. Within the model specification YAML (e.g., school location, work location), the user needs to specify a property called SAVED_SHADOW_PRICE_TABLE_NAME. These shadow prices appear to read from the data folder by default. The ActivitySim documentation does not include any references to this parameter nor does it include any information about the format of this table.

Saving Shadow Prices

At the end of each shadow pricing iteration, ActivitySim safes shadow prices to the output as "trace files". Its not super clear this is what is actually happening from the end user perspective based on file naming conventions

Suggested Fix:

  1. Add documentation for the SAVED_SHADOW_PRICE_TABLE_NAME. @bstabler: The question here is where should the documentation be updated. TBH, it would be nice if the documentation included a descriptor of each of the model specification files.

  2. Add documentation to the same location as above indicating that the "trace" files are, in fact, the warm start tables. @bstabler: Again, where in the documentation should this go.

bstabler commented 3 years ago

I think we should add more documentation for shadow pricing here. This section is largely built from the code docstrings, but it looks like the ShadowPriceCalculator docstrings are not included so much of the documentation didn't make it onto to the webpage. I assume you can make the doc updates, but if you need help, just let me know. Thanks.

danielsclint commented 3 years ago

I added a more lay man's set of documentation to the RST files.

https://github.com/ActivitySim/activitysim/pull/480

bstabler commented 3 years ago

this was completed under #480