Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation on deployment wide search #454

Merged
merged 5 commits into from
Mar 12, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Improve documentation on deployment wide search
SirOibaf committed Mar 12, 2025
commit d814143fe5227639acffbef7ca24089531b9e624
24 changes: 17 additions & 7 deletions docs/concepts/projects/search.md
Original file line number Diff line number Diff line change
@@ -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.