feature: model metadata query #1749

fregataa · 2023-11-29T14:07:19Z

related to #1066

Example `model-definition.yaml` file

models:
  - name: "simple-http-server"
    model_path: "/models"
    service:
      pre_start_actions:
        - action: run_command
          args:
            command: ["pip", "install", "-r", "/models/requirements.txt"]
      start_command:
        - python
        - /models/server.py
      port: 8000
      health_check:
        path: /health
        max_retries: 5
    metadata:
      author: "John Doe"
      version: 3
      created: "2019-01-01T00:00:00Z"
      last_modified: "2019-12-31T00:00:00Z"
      description: "This is a simple HTTP server"
      title: "Simple http server. Human readable name."
      task: "HTTP server"
      category: "langauge"
      label: 
        - "language"
      license: "Apache-2.0"
      min_resource:
        cpu: 1
        memory: 256m

Query Model Info connection(list)

query ModelInfoQuery {
    model_infos {
        edges {
            cursor
            node {
                name
                author
                title
                version
                created_at
                modified_at
                description
                task
                category
                label
                license
                min_resource
            }
        }
        count
        pageInfo {
            hasNextPage
            hasPreviousPage
        }
    }
}

Query single Model Info node

query ModelInfoQuery {
    model_info(id: "TW9kZWxJbmZvOjQ4M2RiY2Q5LTgxOGItNGJhYS1iMWI1LTFlNTY0NDI1NTczMw==") {
        name
        author
        title
        version
        created_at
        modified_at
        description
        task
        category
        label
        license
        min_resource
    }
}

Checklist: (if applicable)

Milestone metadata specifying the target backport version
Mention to the original issue
Documentation
API server-client counterparts (e.g., manager API -> client SDK)
Test case(s) to demonstrate the difference of before/after

…ure/model-card-ui

agatha197

LGTM

inureyes

LGTM

achimnol

Please fix some code-level, naming issues.

achimnol · 2023-12-05T01:37:40Z

src/ai/backend/manager/api/vfolder.py

+    if group_type == ProjectType.MODEL_STORE:
+        if params["permission"] != VFolderPermission.READ_WRITE:
+            raise InvalidAPIParameters(
+                "Setting custom permission is not supported for model store VFolder"


When mentioned in the middle of sentences, use "vfolder", not "VFolder".

achimnol · 2023-12-05T01:40:26Z

src/ai/backend/manager/api/vfolder.py

@@ -450,7 +454,7 @@ async def create(request: web.Request, params: Any) -> web.Response:
        if group_uuid is not None:
            ownership_type = "group"
            quota_scope_id = QuotaScopeID(QuotaScopeType.PROJECT, group_uuid)
-            if not request["is_admin"]:
+            if not request["is_admin"] and group_type != ProjectType.MODEL_STORE:


Is this about forbidding model vfolder creation in the model store by a non-admin user?
Previously, project vfolder creation was already forbidden for non-admin users.
Is this additional condition strictly necessary? I think it may be better to just add comments.

achimnol · 2023-12-05T01:42:14Z

src/ai/backend/manager/models/alembic/versions/308bcecec5c2_add_groups_type.py

+
+def downgrade():
+    conn = op.get_bind()
+    conn.execute(text("DELETE FROM groups WHERE name = 'model-store'"))


This should refer the type column, not the name column.
(FYI: To use a keyword like type, user, etc. as a column name in SQL, surround it with double-quotes.)

achimnol · 2023-12-05T01:43:50Z

src/ai/backend/manager/models/group.py

@@ -111,6 +114,11 @@ class AssocGroupUserRow(Base):
    group = relationship("GroupRow", back_populates="users")


+class ProjectType(str, enum.Enum):


Use enum.StrEnum as of Python 3.11 and for the new codes that won't be backported to 22.09 or older.

achimnol · 2023-12-05T01:45:53Z

src/ai/backend/web/config.py

@@ -75,6 +75,7 @@
                t.Key("directory_based_usage", default=False): t.ToBool(),
                t.Key("allow_custom_resource_allocation", default=True): t.ToBool(),
                t.Key("edu_appname_prefix", default=""): t.String(allow_blank=True),
+                t.Key("support_model_store", default=True): t.ToBool(),


The name should be enable_model_store.
"Not support" means that we don't have the ability to serve the model store.
Here we should be clear that we DO support it but it's simply disabled when this field is set false.

achimnol · 2023-12-05T01:46:11Z

src/ai/backend/web/templates/config.toml.j2

@@ -30,6 +30,7 @@ connectionMode = "SESSION"
 {% toml_field "allowCustomResourceAllocation" config["service"]["allow_custom_resource_allocation"] %}
 {% toml_field "isDirectorySizeVisible" config["service"]["is_directory_size_visible"] %}
 {% toml_field "eduAppNamePrefix" config["service"]["edu_appname_prefix"] %}
+{% toml_field "supportModelStore" config["service"]["support_model_store"] %}


achimnol · 2023-12-05T01:47:00Z

src/ai/backend/common/config.py

@@ -121,6 +121,29 @@
                            ),
                        }
                    ),
+                    t.Key("info"): t.Null | t.Dict(


I'd suggest using a more concrete field name like "metadata" or "card".

…ure/model-card-ui

Co-authored-by: Jeongkyu Shin <[email protected]> Co-authored-by: Kyujin Cho <[email protected]>

feature: model metadata query

28b4411

fregataa added this to the 24.03 milestone Nov 29, 2023

fregataa requested review from inureyes and agatha197 November 29, 2023 14:07

fregataa self-assigned this Nov 29, 2023

github-actions bot added comp:manager Related to Manager component size:L 100~500 LoC labels Nov 29, 2023

fregataa and others added 14 commits November 29, 2023 23:13

remove test yaml

24209a2

filter out non-model vfolders

ad4d01b

return default model info

f775b3a

fix fields and resolvers

7988b97

missing label field and validation

54ed0ad

filter out dead vfolders

d9c1afd

update: change label format to list type

2223073

add: architecture, framework

8221a15

update: IV for new fields

e5fb0ff

detail metadata validation

0765168

Merge remote-tracking branch 'origin/feature/model-card-ui' into feat…

f7bbcd6

…ure/model-card-ui

change framework field to list

e699848

add support for project type feature

559b1f4

add support for model store creation API

41eace9

github-actions bot added the require:db-migration Automatically set when alembic migrations are added or updated label Nov 30, 2023

kyujin-cho added 5 commits November 30, 2023 21:05

add parameter description

6eff304

describe enum values programmatically

bd4467f

expose README related attributes

ce2d130

enhance readme detection

c85a5f2

add migration file:

751962a

github-actions bot added size:XL 500~ LoC and removed size:L 100~500 LoC labels Nov 30, 2023

limit agus manipulation to users in default domain only

74a3129

agatha197 approved these changes Dec 4, 2023

View reviewed changes

inureyes approved these changes Dec 5, 2023

View reviewed changes

add: towncrier changelog

f12ae64

Merge branch 'main' into feature/model-card-ui

35a9784

achimnol requested changes Dec 5, 2023

View reviewed changes

fregataa added 6 commits December 5, 2023 12:00

Merge branch 'main' into feature/model-card-ui

18b4332

change 'info' to 'metadata'

0c71659

Merge remote-tracking branch 'origin/feature/model-card-ui' into feat…

c8fa6c7

…ure/model-card-ui

change schema name from model_info to model_metadata

a3d87c6

minor fixes

b89e372

change name from model-metadata to model-card

715c659

github-actions bot added the comp:storage-proxy Related to Storage proxy component label Dec 5, 2023

fregataa requested a review from achimnol December 5, 2023 05:47

update test fixtures

f1af854

fregataa added this pull request to the merge queue Dec 5, 2023

Merged via the queue into main with commit a4f62f9 Dec 5, 2023
25 checks passed

fregataa deleted the feature/model-card-ui branch December 5, 2023 07:10

This was referenced Dec 5, 2023

Improve model serving #1760

Open

fix: wrong group creation in mutate UserCreation #1762

Merged

mirageoasis pushed a commit that referenced this pull request Dec 8, 2023

feature: model metadata query (#1749)

bde663f

Co-authored-by: Jeongkyu Shin <[email protected]> Co-authored-by: Kyujin Cho <[email protected]>

kyujin-cho mentioned this pull request Jan 8, 2024

fix: make metadata field of model definition optional #1825

Merged

2 tasks

rapsealk mentioned this pull request Jan 30, 2024

fix: Keypair double-count across multiple projects #1869

Merged

7 tasks

agatha197 mentioned this pull request Mar 26, 2024

Let's disallow to create, modify, and delete MODEL_STORE type project. #1964

Open

fregataa mentioned this pull request Jul 1, 2024

fix: Cannot resolve model_card GQL query #2161

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: model metadata query #1749

feature: model metadata query #1749

fregataa commented Nov 29, 2023 •

edited

Loading

agatha197 left a comment

inureyes left a comment

achimnol left a comment

achimnol Dec 5, 2023

achimnol Dec 5, 2023

achimnol Dec 5, 2023

achimnol Dec 5, 2023

achimnol Dec 5, 2023

achimnol Dec 5, 2023

achimnol Dec 5, 2023

		@@ -111,6 +114,11 @@ class AssocGroupUserRow(Base):
		group = relationship("GroupRow", back_populates="users")


		class ProjectType(str, enum.Enum):

feature: model metadata query #1749

feature: model metadata query #1749

Conversation

fregataa commented Nov 29, 2023 • edited Loading

Example model-definition.yaml file

Query Model Info connection(list)

Query single Model Info node

agatha197 left a comment

Choose a reason for hiding this comment

inureyes left a comment

Choose a reason for hiding this comment

achimnol left a comment

Choose a reason for hiding this comment

achimnol Dec 5, 2023

Choose a reason for hiding this comment

achimnol Dec 5, 2023

Choose a reason for hiding this comment

achimnol Dec 5, 2023

Choose a reason for hiding this comment

achimnol Dec 5, 2023

Choose a reason for hiding this comment

achimnol Dec 5, 2023

Choose a reason for hiding this comment

achimnol Dec 5, 2023

Choose a reason for hiding this comment

achimnol Dec 5, 2023

Choose a reason for hiding this comment

fregataa commented Nov 29, 2023 •

edited

Loading

Example `model-definition.yaml` file