Skip to content
This repository was archived by the owner on Nov 14, 2023. It is now read-only.

feat: added support for walking mode and cost_per_kilometer_below_soft_max #151

Merged
merged 2 commits into from
Sep 7, 2023
Merged

feat: added support for walking mode and cost_per_kilometer_below_soft_max #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e79f752
feat: added support for walking mode and cost_per_kilometer_below_sof…
gcf-owl-bot[bot] Sep 6, 2023
c0d3345
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 50 additions & 19 deletions google/cloud/optimization_v1/types/fleet_routing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,6 @@ class OptimizeToursRequest(proto.Message):
Shipment model to solve.
solving_mode (google.cloud.optimization_v1.types.OptimizeToursRequest.SolvingMode):
By default, the solving mode is ``DEFAULT_SOLVE`` (0).
max_validation_errors (int):
Truncates the number of validation errors returned. These
errors are typically attached to an INVALID_ARGUMENT error
payload as a BadRequest error detail
(https://cloud.google.com/apis/design/errors#error_details),
unless solving_mode=VALIDATE_ONLY: see the
[OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors]
field. This defaults to 100 and is capped at 10,000.

This field is a member of `oneof`_ ``_max_validation_errors``.
search_mode (google.cloud.optimization_v1.types.OptimizeToursRequest.SearchMode):
Search mode used to solve the request.
injected_first_solution_routes (MutableSequence[google.cloud.optimization_v1.types.ShipmentRoute]):
Expand Down Expand Up @@ -271,6 +261,16 @@ class OptimizeToursRequest(proto.Message):
Its value must be at least 1.0 meters/seconds.

This field is a member of `oneof`_ ``_geodesic_meters_per_second``.
max_validation_errors (int):
Truncates the number of validation errors returned. These
errors are typically attached to an INVALID_ARGUMENT error
payload as a BadRequest error detail
(https://cloud.google.com/apis/design/errors#error_details),
unless solving_mode=VALIDATE_ONLY: see the
[OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors]
field. This defaults to 100 and is capped at 10,000.

This field is a member of `oneof`_ ``_max_validation_errors``.
label (str):
Label that may be used to identify this request, reported
back in the
Expand Down Expand Up @@ -301,12 +301,20 @@ class SolvingMode(proto.Enum):
as possible.
DETECT_SOME_INFEASIBLE_SHIPMENTS (2):
Only populates
[OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors]
or
[OptimizeToursResponse.skipped_shipments][google.cloud.optimization.v1.OptimizeToursResponse.skipped_shipments],
and doesn't actually solve the rest of the request
(``status`` and ``routes`` are unset in the response).
(``status`` and ``routes`` are unset in the response). If
infeasibilities in ``injected_solution_constraint`` routes
are detected they are populated in the
[OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors]
field and
[OptimizeToursResponse.skipped_shipments][google.cloud.optimization.v1.OptimizeToursResponse.skipped_shipments]
is left empty.

*IMPORTANT*: not all infeasible shipments are returned here,
but only the ones that are detected as infeasible as a
but only the ones that are detected as infeasible during
preprocessing.
"""
DEFAULT_SOLVE = 0
Expand Down Expand Up @@ -351,11 +359,6 @@ class SearchMode(proto.Enum):
number=4,
enum=SolvingMode,
)
max_validation_errors: int = proto.Field(
proto.INT32,
number=5,
optional=True,
)
search_mode: SearchMode = proto.Field(
proto.ENUM,
number=6,
Expand Down Expand Up @@ -407,6 +410,11 @@ class SearchMode(proto.Enum):
number=16,
optional=True,
)
max_validation_errors: int = proto.Field(
proto.INT32,
number=5,
optional=True,
)
label: str = proto.Field(
proto.STRING,
number=17,
Expand Down Expand Up @@ -1915,9 +1923,13 @@ class TravelMode(proto.Enum):
DRIVING (1):
Travel mode corresponding to driving
directions (car, ...).
WALKING (2):
Travel mode corresponding to walking
directions.
"""
TRAVEL_MODE_UNSPECIFIED = 0
DRIVING = 1
WALKING = 2

class UnloadingPolicy(proto.Enum):
r"""Policy on how a vehicle can be unloaded. Applies only to shipments
Expand Down Expand Up @@ -2450,6 +2462,18 @@ class DistanceLimit(proto.Message):
must be nonnegative.

This field is a member of `oneof`_ ``_soft_max_meters``.
cost_per_kilometer_below_soft_max (float):
Cost per kilometer incurred, increasing up to
``soft_max_meters``, with formula:

::

min(distance_meters, soft_max_meters) / 1000.0 *
cost_per_kilometer_below_soft_max.

This cost is not supported in ``route_distance_limit``.

This field is a member of `oneof`_ ``_cost_per_kilometer_below_soft_max``.
cost_per_kilometer_above_soft_max (float):
Cost per kilometer incurred if distance is above
``soft_max_meters`` limit. The additional cost is 0 if the
Expand All @@ -2476,6 +2500,11 @@ class DistanceLimit(proto.Message):
number=2,
optional=True,
)
cost_per_kilometer_below_soft_max: float = proto.Field(
proto.DOUBLE,
number=4,
optional=True,
)
cost_per_kilometer_above_soft_max: float = proto.Field(
proto.DOUBLE,
number=3,
Expand Down Expand Up @@ -3858,8 +3887,8 @@ class Level(proto.Enum):
or before them.
RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD (2):
Same as ``RELAX_VISIT_TIMES_AFTER_THRESHOLD``, but the visit
sequence is also relaxed: visits remain simply bound to
their vehicle.
sequence is also relaxed: visits can only be performed by
this vehicle, but can potentially become unperformed.
RELAX_ALL_AFTER_THRESHOLD (3):
Same as ``RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD``,
but the vehicle is also relaxed: visits are completely free
Expand Down Expand Up @@ -3985,6 +4014,8 @@ class OptimizeToursValidationError(proto.Message):
- INJECTED_SOLUTION_CONCURRENT_SOLUTION_TYPES = 2005;
- INJECTED_SOLUTION_MORE_THAN_ONE_PER_TYPE = 2006;
- INJECTED_SOLUTION_REFRESH_WITHOUT_POPULATE = 2008;
- INJECTED_SOLUTION_CONSTRAINED_ROUTE_PORTION_INFEASIBLE
= 2010;

- SHIPMENT_MODEL_ERROR = 22;

Expand Down
2 changes: 1 addition & 1 deletion scripts/fixup_optimization_v1_keywords.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class optimizationCallTransformer(cst.CSTTransformer):
CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata')
METHOD_TO_PARAMS: Dict[str, Tuple[str]] = {
'batch_optimize_tours': ('parent', 'model_configs', ),
'optimize_tours': ('parent', 'timeout', 'model', 'solving_mode', 'max_validation_errors', 'search_mode', 'injected_first_solution_routes', 'injected_solution_constraint', 'refresh_details_routes', 'interpret_injected_solutions_using_labels', 'consider_road_traffic', 'populate_polylines', 'populate_transition_polylines', 'allow_large_deadline_despite_interruption_risk', 'use_geodesic_distances', 'geodesic_meters_per_second', 'label', 'populate_travel_step_polylines', ),
'optimize_tours': ('parent', 'timeout', 'model', 'solving_mode', 'search_mode', 'injected_first_solution_routes', 'injected_solution_constraint', 'refresh_details_routes', 'interpret_injected_solutions_using_labels', 'consider_road_traffic', 'populate_polylines', 'populate_transition_polylines', 'allow_large_deadline_despite_interruption_risk', 'use_geodesic_distances', 'geodesic_meters_per_second', 'max_validation_errors', 'label', 'populate_travel_step_polylines', ),
}

def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode:
Expand Down