Skip to content

Commit

Permalink
Docs: clarify that budget might be ignored when creating job
Browse files Browse the repository at this point in the history
  • Loading branch information
soxofaan committed Jul 15, 2024
1 parent fede931 commit 151aede
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 8 deletions.
5 changes: 3 additions & 2 deletions openeo/rest/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -1714,8 +1714,9 @@ def create_job(
or as local file path or URL
:param title: job title
:param description: job description
:param plan: billing plan
:param budget: maximum cost the request is allowed to produce
:param plan: The billing plan to process and charge the job with
:param budget: Maximum budget to be spent on executing the job.
Note that some backends do not honor this limit.
:param additional: additional job options to pass to the backend
:param validate: Optional toggle to enable/prevent validation of the process graphs before execution
(overruling the connection's ``auto_validate`` setting).
Expand Down
5 changes: 3 additions & 2 deletions openeo/rest/datacube.py
Original file line number Diff line number Diff line change
Expand Up @@ -2268,8 +2268,9 @@ def create_job(
:param out_format: output file format.
:param title: job title
:param description: job description
:param plan: billing plan
:param budget: maximum cost the request is allowed to produce
:param plan: The billing plan to process and charge the job with
:param budget: Maximum budget to be spent on executing the job.
Note that some backends do not honor this limit.
:param job_options: custom job options.
:param validate: Optional toggle to enable/prevent validation of the process graphs before execution
(overruling the connection's ``auto_validate`` setting).
Expand Down
5 changes: 3 additions & 2 deletions openeo/rest/mlmodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,9 @@ def create_job(
:param title: job title
:param description: job description
:param plan: billing plan
:param budget: maximum cost the request is allowed to produce
:param plan: The billing plan to process and charge the job with
:param budget: Maximum budget to be spent on executing the job.
Note that some backends do not honor this limit.
:param job_options: A dictionary containing (custom) job options
:param format_options: String Parameters for the job result format
:return: Created job.
Expand Down
5 changes: 3 additions & 2 deletions openeo/rest/vectorcube.py
Original file line number Diff line number Diff line change
Expand Up @@ -320,8 +320,9 @@ def create_job(
:param out_format: String Format of the job result.
:param title: job title
:param description: job description
:param plan: billing plan
:param budget: maximum cost the request is allowed to produce
:param plan: The billing plan to process and charge the job with
:param budget: Maximum budget to be spent on executing the job.
Note that some backends do not honor this limit.
:param job_options: A dictionary containing (custom) job options
:param format_options: String Parameters for the job result format
:param validate: Optional toggle to enable/prevent validation of the process graphs before execution
Expand Down

0 comments on commit 151aede

Please sign in to comment.