googleapis / googleapis/python-aiplatform

non-intuitive behaviour of list method

Open
#4,578 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api: vertex-ai
Dominant language
Python
Stars
907
Forks
466
Avg merge
1d 13h
Merged PRs (30d)
44

Description

The list method of PipelineJobSchedule class will revert to using the aiplatform init values for project and region if none are passed explicitly.
This is counter-intuitive as when we instantiate the class PipelineJobSchedule we can pass these params that will then be ignored in the list method but instead will be used when using the create method.
This can cause a source of confusion and bugs in multi-project-deployment environments.
A better behaviour when calling the list method would be:

  1. use explicit values
  2. if not available use the values of the self object if such is instantiated
  3. if not available use the default of the environment

Reference:
https://github.com/googleapis/python-aiplatform/blob/5025d03d808971102995113a871c2ef78c2fb013/google/cloud/aiplatform/pipeline_job_schedules.py#L271

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at google/cloud/aiplatform/pipeline_job_schedules.py around line 271 and inspect how PipelineJobSchedule.list resolves project and region compared with initialization and create. Verify the resolution order for explicit values, the self object's values, and environment defaults, and add or update coverage for those cases. Done means list no longer ignores constructor values when explicit arguments are absent.

Written by the indexing model from the issue text.

Assessment

Tech stack
google-cloud, python
Domain
ai
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.