Update SDK to use paginated API

api/api/prediction_job_api.go

@@ -99,8 +99,8 @@ func (c *PredictionJobController) List(r *http.Request, vars map[string]string,
 	return Ok(jobs)
 }
 
-// ListInPage method lists all prediction jobs of a model and version ID, in the given page.
-func (c *PredictionJobController) ListInPage(r *http.Request, vars map[string]string, _ interface{}) *Response {
+// ListInPage method lists all prediction jobs of a model and version ID, with pagination.
+func (c *PredictionJobController) ListByPage(r *http.Request, vars map[string]string, _ interface{}) *Response {
 	ctx := r.Context()
 
 	modelID, _ := models.ParseID(vars["model_id"])
@@ -264,3 +264,45 @@ func (c *PredictionJobController) ListAllInProject(r *http.Request, vars map[str
 
 	return Ok(jobs)
 }
+
+// ListAllInProject lists all prediction jobs of a project, with pagination
+func (c *PredictionJobController) ListAllInProjectByPage(r *http.Request, vars map[string]string, body interface{}) *Response {
+	ctx := r.Context()
+
+	var query service.ListPredictionJobQuery
+	err := decoder.Decode(&query, r.URL.Query())
+	if err != nil {
+		return BadRequest(fmt.Sprintf("Bad query %s", r.URL.Query()))
+	}
+
+	projectID, _ := models.ParseID(vars["project_id"])
+	page, pageErr := strconv.Atoi(vars["page"])
+	pageSize, pageSizeErr := strconv.Atoi(vars["page_size"])
+
+	project, err := c.ProjectsService.GetByID(ctx, int32(projectID))
+	if err != nil {
+		return NotFound(fmt.Sprintf("Project not found: %v", err))
+	}
+
+	// We will append page and pageSize to the query if they are set.
+	paginationOpts := pagination.Options{}
+	if pageErr == nil {
+		pageInt32 := int32(page)
+		paginationOpts.Page = &pageInt32
+	}
+	if pageSizeErr == nil {
+		pageSizeInt32 := int32(pageSize)
+		paginationOpts.PageSize = &pageSizeInt32
+	}
+	query.Pagination = paginationOpts
+
+	jobs, paging, err := c.PredictionJobService.ListPredictionJobs(ctx, project, &query)
+	if err != nil {
+		return InternalServerError(fmt.Sprintf("Error listing prediction jobs: %v", err))
+	}
+
+	return Ok(ListJobsPaginatedResponse{
+		Results: jobs,
+		Paging:  paging,
+	})
+}

api/api/router.go

@@ -226,9 +226,9 @@ func NewRouter(appCtx AppContext) (*mux.Router, error) {
 
 		// Prediction Job API
 		{http.MethodGet, "/projects/{project_id:[0-9]+}/jobs", nil, predictionJobController.ListAllInProject, "ListAllPredictionJobInProject"},
-		//{http.MethodGet, "/projects/{project_id:[0-9]+}/jobs-by-page", nil, predictionJobController.ListAllInProjectInPage, "ListAllInProjectInPage"},
+		{http.MethodGet, "/projects/{project_id:[0-9]+}/jobs-by-page", nil, predictionJobController.ListAllInProjectByPage, "ListAllInProjectInPage"},
 		{http.MethodGet, "/models/{model_id:[0-9]+}/versions/{version_id:[0-9]+}/jobs", nil, predictionJobController.List, "ListPredictionJob"},
-		{http.MethodGet, "/models/{model_id:[0-9]+}/versions/{version_id:[0-9]+}/jobs-by-page", nil, predictionJobController.ListInPage, "ListPredictionJobInPage"},
+		{http.MethodGet, "/models/{model_id:[0-9]+}/versions/{version_id:[0-9]+}/jobs-by-page", nil, predictionJobController.ListByPage, "ListPredictionJobInPage"},
 		{http.MethodGet, "/models/{model_id:[0-9]+}/versions/{version_id:[0-9]+}/jobs/{job_id:[0-9]+}", nil, predictionJobController.Get, "GetPredictionJob"},
 		{http.MethodPut, "/models/{model_id:[0-9]+}/versions/{version_id:[0-9]+}/jobs/{job_id:[0-9]+}/stop", nil, predictionJobController.Stop, "StopPredictionJob"},
 		{http.MethodPost, "/models/{model_id:[0-9]+}/versions/{version_id:[0-9]+}/jobs", models.PredictionJob{}, predictionJobController.Create, "CreatePredictionJob"},

python/sdk/client/api/prediction_jobs_api.py

@@ -56,7 +56,6 @@ def models_model_id_versions_version_id_jobs_by_page_get(
         self,
         model_id: StrictInt,
         version_id: StrictInt,
-        project_id: StrictInt,
         page: Optional[StrictInt] = None,
         page_size: Annotated[Optional[StrictInt], Field(description="Number of items on each page. It defaults to 50.")] = None,
         _request_timeout: Union[
@@ -79,8 +78,6 @@ def models_model_id_versions_version_id_jobs_by_page_get(
         :type model_id: int
         :param version_id: (required)
         :type version_id: int
-        :param project_id: (required)
-        :type project_id: int
         :param page:
         :type page: int
         :param page_size: Number of items on each page. It defaults to 50.
@@ -110,7 +107,6 @@ def models_model_id_versions_version_id_jobs_by_page_get(
         _param = self._models_model_id_versions_version_id_jobs_by_page_get_serialize(
             model_id=model_id,
             version_id=version_id,
-            project_id=project_id,
             page=page,
             page_size=page_size,
             _request_auth=_request_auth,
@@ -140,7 +136,6 @@ def models_model_id_versions_version_id_jobs_by_page_get_with_http_info(
         self,
         model_id: StrictInt,
         version_id: StrictInt,
-        project_id: StrictInt,
         page: Optional[StrictInt] = None,
         page_size: Annotated[Optional[StrictInt], Field(description="Number of items on each page. It defaults to 50.")] = None,
         _request_timeout: Union[
@@ -163,8 +158,6 @@ def models_model_id_versions_version_id_jobs_by_page_get_with_http_info(
         :type model_id: int
         :param version_id: (required)
         :type version_id: int
-        :param project_id: (required)
-        :type project_id: int
         :param page:
         :type page: int
         :param page_size: Number of items on each page. It defaults to 50.
@@ -194,7 +187,6 @@ def models_model_id_versions_version_id_jobs_by_page_get_with_http_info(
         _param = self._models_model_id_versions_version_id_jobs_by_page_get_serialize(
             model_id=model_id,
             version_id=version_id,
-            project_id=project_id,
             page=page,
             page_size=page_size,
             _request_auth=_request_auth,
@@ -224,7 +216,6 @@ def models_model_id_versions_version_id_jobs_by_page_get_without_preload_content
         self,
         model_id: StrictInt,
         version_id: StrictInt,
-        project_id: StrictInt,
         page: Optional[StrictInt] = None,
         page_size: Annotated[Optional[StrictInt], Field(description="Number of items on each page. It defaults to 50.")] = None,
         _request_timeout: Union[
@@ -247,8 +238,6 @@ def models_model_id_versions_version_id_jobs_by_page_get_without_preload_content
         :type model_id: int
         :param version_id: (required)
         :type version_id: int
-        :param project_id: (required)
-        :type project_id: int
         :param page:
         :type page: int
         :param page_size: Number of items on each page. It defaults to 50.
@@ -278,7 +267,6 @@ def models_model_id_versions_version_id_jobs_by_page_get_without_preload_content
         _param = self._models_model_id_versions_version_id_jobs_by_page_get_serialize(
             model_id=model_id,
             version_id=version_id,
-            project_id=project_id,
             page=page,
             page_size=page_size,
             _request_auth=_request_auth,
@@ -303,7 +291,6 @@ def _models_model_id_versions_version_id_jobs_by_page_get_serialize(
         self,
         model_id,
         version_id,
-        project_id,
         page,
         page_size,
         _request_auth,
@@ -330,8 +317,6 @@ def _models_model_id_versions_version_id_jobs_by_page_get_serialize(
             _path_params['model_id'] = model_id
         if version_id is not None:
             _path_params['version_id'] = version_id
-        if project_id is not None:
-            _path_params['project_id'] = project_id
         # process the query parameters
         if page is not None:
 

python/sdk/merlin/model.py

@@ -1559,12 +1559,24 @@ def list_prediction_job(self) -> List[PredictionJob]:
         :return: list of prediction jobs
         """
         job_client = client.PredictionJobsApi(self._api_client)
-        res = job_client.models_model_id_versions_version_id_jobs_get(
+
+        res = job_client.models_model_id_versions_version_id_jobs_by_page_get(
             model_id=self.model.id, version_id=self.id
         )
         jobs = []
-        for j in res:
+        for j in res.results:
             jobs.append(PredictionJob(j, self._api_client))
+
+        # Paginated response. Parse the rest of the pages.
+        total_pages = res.paging.pages
+        page = 2
+        while page < total_pages:
+            res = job_client.models_model_id_versions_version_id_jobs_by_page_get(
+                model_id=self.model.id, version_id=self.id, page=page
+            )
+            for j in res.results:
+                jobs.append(PredictionJob(j, self._api_client))
+
         return jobs
 
     def start_server(

python/sdk/pyfunc.Dockerfile

@@ -0,0 +1,31 @@
+# Copyright 2020 The Merlin Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+ARG BASE_IMAGE=ghcr.io/caraml-dev/merlin/merlin-pyfunc-base:0.41.0
+FROM ${BASE_IMAGE}
+
+# Download and install user model dependencies
+ARG MODEL_DEPENDENCIES_URL
+COPY ${MODEL_DEPENDENCIES_URL} conda.yaml
+
+ARG MERLIN_DEP_CONSTRAINT
+RUN process_conda_env.sh conda.yaml "merlin-pyfunc-server" "${MERLIN_DEP_CONSTRAINT}"
+RUN conda env create --name merlin-model --file conda.yaml
+
+# Download and dry-run user model artifacts and code
+ARG MODEL_ARTIFACTS_URL
+COPY ${MODEL_ARTIFACTS_URL} model
+RUN /bin/bash -c ". activate merlin-model && merlin-pyfunc-server --model_dir model --dry_run"
+
+CMD ["run.sh"]

python/sdk/standard.Dockerfile

@@ -0,0 +1,20 @@
+# Copyright 2020 The Merlin Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+ARG BASE_IMAGE
+ARG MODEL_PATH
+
+FROM ${BASE_IMAGE}
+
+COPY ${MODEL_PATH} /mnt/models

python/sdk/test/model_test.py

@@ -941,10 +941,15 @@ def test_undeploy_default_env(self, version):
     def test_list_prediction_job(self, version):
         responses.add(
             method="GET",
-            url="/v1/models/1/versions/1/jobs",
-            body=json.dumps(
-                [job_1.to_dict(), job_2.to_dict()], default=serialize_datetime
-            ),
+            url="/v1/models/1/versions/1/jobs-by-page",
+            body=json.dumps({
+                "results": [job_1.to_dict(), job_2.to_dict()],
+                "paging": {
+                    "page": 1,
+                    "pages": 1,
+                    "total": 2,
+                },
+            }, default=serialize_datetime),
             status=200,
             content_type="application/json",
         )

swagger.yaml

@@ -1404,11 +1404,6 @@ paths:
           required: true
           schema:
             type: integer
-        - name: project_id
-          in: path
-          required: true
-          schema:
-            type: integer
         - name: page
           in: query
           schema: