Skip to content

Commit 8a00e0f

Browse files
SirOibafCopilot
andauthored
Improve documentation on deployment wide search (#454) (#455)
* Improve documentation on deployment wide search * Update docs/concepts/projects/search.md * add plural * fix copilot suggestion * add new line --------- Co-authored-by: Copilot <[email protected]>
1 parent df948a9 commit 8a00e0f

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

docs/concepts/projects/search.md

+18-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
Hopsworks supports free-text search for ML assets:
1+
---
2+
description: "Documentation on the Hopsworks capabilities to discover machine-learning assets"
3+
---
24

3-
* features,
4-
* feature groups,
5-
* feature views,
6-
* training data,
7-
* models, and
8-
* deployments.
5+
## Search
6+
7+
Hopsworks supports free-text search to discover machine-learning assets:
8+
9+
* features
10+
* feature groups
11+
* feature views
12+
* training data
913

1014
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.
11-
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.
15+
16+
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.
17+
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.
18+
19+
## Tags
20+
21+
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.
1222

1323
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.
1424

0 commit comments

Comments
 (0)