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

Batch routes: Implement new successThreshold parameter #86

Closed
mvl22 opened this issue Nov 12, 2023 · 0 comments · Fixed by #87
Closed

Batch routes: Implement new successThreshold parameter #86

mvl22 opened this issue Nov 12, 2023 · 0 comments · Fixed by #87

Comments

@mvl22
Copy link
Member

mvl22 commented Nov 12, 2023

The batch routes API has had 99% set as the fixed-value successful threshold for the percentage of routes successfully planned. If not met, the job gets stuck in finalisation state (which we plan to change imminently). The threshold exists to avoid the scenario whereby client uses end up consuming junky data which contains large numbers of failures due to e.g. being in an unroutable area.

There is now a new successThreshold parameter which is now set on a per-job basis, defaulting to 99. This can be set via the API alongside other parameters. It can also be set in the UI. Note it is an int, not float.

https://www.cyclestreets.net/api/v2/batchroutes.createjob/#parametersoptional

This new successThreshold parameter should be implemented in the batch function for this package.

We plan very shortly to enabling a failure below the threshold as a hard fail which will not commission the data files. This would likely result in a new failure status rather than finalising/complete. At present the logic in the code is a little inconsistent due to competing requests from users over the years, whereby the status is stuck on finalisation, the files are not pushed (e.g. to S3 if enabled), but are still written, which the API then discovers.

Robinlovelace added a commit that referenced this issue Nov 13, 2023
Robinlovelace added a commit that referenced this issue Nov 13, 2023
@Robinlovelace Robinlovelace linked a pull request Nov 13, 2023 that will close this issue
Robinlovelace added a commit that referenced this issue Nov 14, 2023
…w-successthreshold-parameter

Add successThreshold, close #86
Robinlovelace added a commit that referenced this issue Nov 14, 2023
…plement-new-successthreshold-parameter

Revert "Add successThreshold, close #86"
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 a pull request may close this issue.

1 participant