From d814143fe5227639acffbef7ca24089531b9e624 Mon Sep 17 00:00:00 2001 From: Fabio Buso Date: Wed, 12 Mar 2025 23:32:24 +0100 Subject: [PATCH 1/5] Improve documentation on deployment wide search --- docs/concepts/projects/search.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/concepts/projects/search.md b/docs/concepts/projects/search.md index 7baa2b253..fc1c27320 100644 --- a/docs/concepts/projects/search.md +++ b/docs/concepts/projects/search.md @@ -1,13 +1,23 @@ -Hopsworks supports free-text search for ML assets: +--- +description: "Documentation on the Hopsworks capabilities to discover machine-learning assets" +--- -* features, -* feature groups, -* feature views, -* training data, -* models, and -* deployments. +## Search + +Hopsworks supports free-text search to discover machine-learning assets: + +* features +* feature groups +* feature views +* training data You can use the search bar at the top of your project to free-text search for the names or descriptions of any ML asset. You can also search using keywords or tags that are attached to an ML asset. + +You can search for assets within a specific project or across all projects in a Hopsworks deployment, including those you are not a member of. This allows for easier discoverability and reusability of assets within an organization. +To avoid users gaining unauthorized access to data, if a search result is in a project you are **not** a member of, the information displayed of is limited to: name, descriptions, tags, asset creator and create date. If the search result is within a project you are a member of, you are also able to inspect recent activities on the asset as well as statistics. + +## Tags + A keyword is a single user-defined word attached to an ML asset. Keywords can be used to help it make it easier to find ML assets or understand the context in which they should be used (for example, *PII* could be used to indicate that the ML asset is based on personally identifiable information. However, it may be preferable to have a stronger governance framework for ML assets than keywords alone. For this, you can define a *schematized tag*, defining a list of key/value tags along with a type for a value. In the figure below, you can see an example of a schematized tag with two key/value pairs: *pii* of type boolean (indicating if this feature group contains PII data), and *owner* of type string (indicating who the owner of the data in this feature group is). Note there is also a keyword defined for this feature group called *eu_region*, indicating the data has its origins in the EU. From 562179d35b70ae2b6836326ad456113410b18646 Mon Sep 17 00:00:00 2001 From: Fabio Buso Date: Wed, 12 Mar 2025 23:34:18 +0100 Subject: [PATCH 2/5] Update docs/concepts/projects/search.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/concepts/projects/search.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/concepts/projects/search.md b/docs/concepts/projects/search.md index fc1c27320..b99f0f0b8 100644 --- a/docs/concepts/projects/search.md +++ b/docs/concepts/projects/search.md @@ -14,8 +14,7 @@ Hopsworks supports free-text search to discover machine-learning assets: You can use the search bar at the top of your project to free-text search for the names or descriptions of any ML asset. You can also search using keywords or tags that are attached to an ML asset. You can search for assets within a specific project or across all projects in a Hopsworks deployment, including those you are not a member of. This allows for easier discoverability and reusability of assets within an organization. -To avoid users gaining unauthorized access to data, if a search result is in a project you are **not** a member of, the information displayed of is limited to: name, descriptions, tags, asset creator and create date. If the search result is within a project you are a member of, you are also able to inspect recent activities on the asset as well as statistics. - +To avoid users gaining unauthorized access to data, if a search result is in a project you are **not** a member of, the information displayed is limited to: name, descriptions, tags, asset creator and create date. If the search result is within a project you are a member of, you are also able to inspect recent activities on the asset as well as statistics. ## Tags A keyword is a single user-defined word attached to an ML asset. Keywords can be used to help it make it easier to find ML assets or understand the context in which they should be used (for example, *PII* could be used to indicate that the ML asset is based on personally identifiable information. From 1f887c3b8dbfc7b51b998ac64066172998b15e09 Mon Sep 17 00:00:00 2001 From: Fabio Buso Date: Wed, 12 Mar 2025 23:35:15 +0100 Subject: [PATCH 3/5] add plural --- docs/concepts/projects/search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/projects/search.md b/docs/concepts/projects/search.md index b99f0f0b8..3376ac302 100644 --- a/docs/concepts/projects/search.md +++ b/docs/concepts/projects/search.md @@ -14,7 +14,7 @@ Hopsworks supports free-text search to discover machine-learning assets: You can use the search bar at the top of your project to free-text search for the names or descriptions of any ML asset. You can also search using keywords or tags that are attached to an ML asset. You can search for assets within a specific project or across all projects in a Hopsworks deployment, including those you are not a member of. This allows for easier discoverability and reusability of assets within an organization. -To avoid users gaining unauthorized access to data, if a search result is in a project you are **not** a member of, the information displayed is limited to: name, descriptions, tags, asset creator and create date. If the search result is within a project you are a member of, you are also able to inspect recent activities on the asset as well as statistics. +To avoid users gaining unauthorized access to data, if a search result is in a project you are **not** a member of, the information displayed is limited to: names, descriptions, tags, asset creator and create date. If the search result is within a project you are a member of, you are also able to inspect recent activities on the asset as well as statistics. ## Tags A keyword is a single user-defined word attached to an ML asset. Keywords can be used to help it make it easier to find ML assets or understand the context in which they should be used (for example, *PII* could be used to indicate that the ML asset is based on personally identifiable information. From 68c2c84b20c0aa978d05e209e92509c83f3d1e14 Mon Sep 17 00:00:00 2001 From: Fabio Buso Date: Wed, 12 Mar 2025 23:42:37 +0100 Subject: [PATCH 4/5] fix copilot suggestion --- docs/concepts/projects/search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/projects/search.md b/docs/concepts/projects/search.md index 3376ac302..9e93de8f6 100644 --- a/docs/concepts/projects/search.md +++ b/docs/concepts/projects/search.md @@ -17,7 +17,7 @@ You can search for assets within a specific project or across all projects in a To avoid users gaining unauthorized access to data, if a search result is in a project you are **not** a member of, the information displayed is limited to: names, descriptions, tags, asset creator and create date. If the search result is within a project you are a member of, you are also able to inspect recent activities on the asset as well as statistics. ## Tags -A keyword is a single user-defined word attached to an ML asset. Keywords can be used to help it make it easier to find ML assets or understand the context in which they should be used (for example, *PII* could be used to indicate that the ML asset is based on personally identifiable information. +A keyword is a single user-defined word attached to an ML asset. Keywords can be used to help it make it easier to find ML assets or understand the context in which they should be used, for example, *PII* could be used to indicate that the ML asset is based on personally identifiable information. However, it may be preferable to have a stronger governance framework for ML assets than keywords alone. For this, you can define a *schematized tag*, defining a list of key/value tags along with a type for a value. In the figure below, you can see an example of a schematized tag with two key/value pairs: *pii* of type boolean (indicating if this feature group contains PII data), and *owner* of type string (indicating who the owner of the data in this feature group is). Note there is also a keyword defined for this feature group called *eu_region*, indicating the data has its origins in the EU. From 7c18b52822d8b2ced6cb4c661c25b32b9d3c16c9 Mon Sep 17 00:00:00 2001 From: Fabio Buso Date: Wed, 12 Mar 2025 23:49:18 +0100 Subject: [PATCH 5/5] add new line --- docs/concepts/projects/search.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/concepts/projects/search.md b/docs/concepts/projects/search.md index 9e93de8f6..174abd199 100644 --- a/docs/concepts/projects/search.md +++ b/docs/concepts/projects/search.md @@ -15,6 +15,7 @@ You can use the search bar at the top of your project to free-text search for th You can search for assets within a specific project or across all projects in a Hopsworks deployment, including those you are not a member of. This allows for easier discoverability and reusability of assets within an organization. To avoid users gaining unauthorized access to data, if a search result is in a project you are **not** a member of, the information displayed is limited to: names, descriptions, tags, asset creator and create date. If the search result is within a project you are a member of, you are also able to inspect recent activities on the asset as well as statistics. + ## Tags A keyword is a single user-defined word attached to an ML asset. Keywords can be used to help it make it easier to find ML assets or understand the context in which they should be used, for example, *PII* could be used to indicate that the ML asset is based on personally identifiable information.