[FSTORE-1911] Improving API Docs for Transformation Functions.#748
Open
manu-sj wants to merge 7 commits into
Open
[FSTORE-1911] Improving API Docs for Transformation Functions.#748manu-sj wants to merge 7 commits into
manu-sj wants to merge 7 commits into
Conversation
manu-sj
changed the title
aversey
reviewed
Mar 16, 2026
Contributor
There was a problem hiding this comment.
Nope, the API reference is controlled via the @public decorator in hopsworks-api. These files should be removed. To link to the API Reference, use the import path in square brackets:
[`@udf`][hsfs.hopsworks_udf.udf]
aversey
reviewed
Mar 16, 2026
Contributor
There was a problem hiding this comment.
This file should be in the concept section (or maybe guide) in logicalclocks.github.io (or a part of a docstring).
docs folder was removed from hopsworks-api.
aversey
reviewed
Mar 16, 2026
|
|
||
| Transforms each value using the formula: | ||
|
|
||
| scaled = (value - min) / (max - min) |
Contributor
There was a problem hiding this comment.
Better to use ```python instead of indentation-based code blocks.
aversey
reviewed
Mar 16, 2026
|
|
||
| where `min` and `max` are computed from the training dataset. | ||
| This transformation is useful for features that need to be bounded within a specific range, | ||
| particularly for algorithms sensitive to feature scales (e.g., neural networks, KNN). |
Contributor
There was a problem hiding this comment.
Sentence per line is to be used for clearer git diff and blame.
aversey
reviewed
Mar 16, 2026
| Returns: | ||
| Scaled feature values in the range [0, 1]. | ||
|
|
||
| See Also: |
Contributor
There was a problem hiding this comment.
There is no such admonition. You can use:
Tip: See Also
...
aversey
reviewed
Mar 16, 2026
| Dictionary mapping transformed feature names to callable functions. | ||
|
|
||
| See Also: | ||
| - [`transform()`][hsfs.feature_view.FeatureView.transform]: Apply all transformations to a feature vector. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [`transform()`][hsfs.feature_view.FeatureView.transform]: Apply all transformations to a feature vector. | |
| - [`FeatureView.transform`][hsfs.feature_view.FeatureView.transform]: Apply all transformations to a feature vector. |
aversey
reviewed
Mar 16, 2026
|
|
||
| See Also: | ||
| - [`TransformationType.MODEL_DEPENDENT`][hsfs.transformation_function.TransformationType]: Transformation type description. | ||
| - [`on_demand_transformations`][hsfs.feature_view.FeatureView.on_demand_transformations]: On-demand transformations from feature groups. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [`on_demand_transformations`][hsfs.feature_view.FeatureView.on_demand_transformations]: On-demand transformations from feature groups. | |
| - [`FeatureView.on_demand_transformations`][hsfs.feature_view.FeatureView.on_demand_transformations]: On-demand transformations from feature groups. |
aversey
reviewed
Mar 16, 2026
| List of parameter names required by on-demand transformations. | ||
|
|
||
| See Also: | ||
| - [`on_demand_transformations`][hsfs.feature_view.FeatureView.on_demand_transformations]: The on-demand transformation functions. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [`on_demand_transformations`][hsfs.feature_view.FeatureView.on_demand_transformations]: The on-demand transformation functions. | |
| - [`FeatureView.on_demand_transformations`][hsfs.feature_view.FeatureView.on_demand_transformations]: The on-demand transformation functions. |
aversey
reviewed
Mar 16, 2026
| Dictionary mapping on-demand feature names to callable functions. | ||
|
|
||
| See Also: | ||
| - [`compute_on_demand_features()`][hsfs.feature_view.FeatureView.compute_on_demand_features]: Compute all on-demand features. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [`compute_on_demand_features()`][hsfs.feature_view.FeatureView.compute_on_demand_features]: Compute all on-demand features. | |
| - [`FeatureView.compute_on_demand_features`][hsfs.feature_view.FeatureView.compute_on_demand_features]: Compute all on-demand features. |
aversey
reviewed
Mar 16, 2026
|
|
||
| See Also: | ||
| - [`compute_on_demand_features()`][hsfs.feature_view.FeatureView.compute_on_demand_features]: Compute all on-demand features. | ||
| - [`request_parameters`][hsfs.feature_view.FeatureView.request_parameters]: Parameters needed for on-demand computation. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [`request_parameters`][hsfs.feature_view.FeatureView.request_parameters]: Parameters needed for on-demand computation. | |
| - [`FeatureView.request_parameters`][hsfs.feature_view.FeatureView.request_parameters]: Parameters needed for on-demand computation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds/fixes/changes...
JIRA Issue: -
Priority for Review: -
Related PRs: -
How Has This Been Tested?
Checklist For The Assigned Reviewer: