Skip to content

Commit d4c67d5

Browse files
committed
Fix macro
1 parent 86ccc4c commit d4c67d5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+84
-84
lines changed

docs/setup_installation/common/arrow_flight_duckdb.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ and batch inference data from the Feature Store, as well as creating moderately-
99

1010
When the service is enabled, clients will automatically use it for the following operations:
1111

12-
- [reading Feature Groups](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_group_api/#read)
13-
- [reading Queries](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/query_api/#read)
14-
- [reading Training Datasets](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_view_api/#get_training_data)
15-
- [creating In-Memory Training Datasets](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_view_api/#training_data)
16-
- [reading Batch Inference Data](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_view_api/#get_batch_data)
12+
- [reading Feature Groups](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_group_api/#read)
13+
- [reading Queries](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/query_api/#read)
14+
- [reading Training Datasets](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#get_training_data)
15+
- [creating In-Memory Training Datasets](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#training_data)
16+
- [reading Batch Inference Data](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#get_batch_data)
1717

1818
For larger datasets, clients can still make use of the Spark/Hive backend by explicitly setting
1919
`read_options={"use_hive": True}`.

docs/user_guides/fs/compute_engines.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ Hopsworks is aiming to provide functional parity between the computational engin
2121

2222
| Functionality | Method | Spark | Python | Flink | Beam | Java | Comment |
2323
| ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------ | ---------------------- | ------------------ | ------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
24-
| Feature Group Creation from dataframes | [`FeatureGroup.create_feature_group()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/feature_group_api/#create_feature_group) | :white_check_mark: | :white_check_mark: | - | - | - | Currently Flink/Beam/Java doesn't support registering feature group metadata.
24+
| Feature Group Creation from dataframes | [`FeatureGroup.create_feature_group()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/feature_group_api/#create_feature_group) | :white_check_mark: | :white_check_mark: | - | - | - | Currently Flink/Beam/Java doesn't support registering feature group metadata.
2525
Thus it needs to be pre-registered before you can write real time features computed by Flink/Beam. |
26-
| Training Dataset Creation from dataframes | [`TrainingDataset.save()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/training_dataset_api/#save) | :white_check_mark: | - | - | - | - | Functionality was deprecated in version 3.0 |
27-
| Data validation using Great Expectations for streaming dataframes | [`FeatureGroup.validate()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/feature_group_api/#validate) <br/> [`FeatureGroup.insert_stream()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/feature_group_api/#insert_stream) | - | - | - | - | - | `insert_stream` does not perform any data validation even when a expectation suite is attached. |
28-
| Stream ingestion | [`FeatureGroup.insert_stream()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/feature_group_api/#insert_stream) | :white_check_mark: | - | :white_check_mark: | :white_check_mark: | :white_check_mark: | Python/Pandas/Polars has currently no notion of streaming. |
29-
| Reading from Streaming Storage Connectors | [`KafkaConnector.read_stream()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/storage_connector_api/#read_stream) | :white_check_mark: | - | - | - | - | Python/Pandas/Polars has currently no notion of streaming.
26+
| Training Dataset Creation from dataframes | [`TrainingDataset.save()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/training_dataset_api/#save) | :white_check_mark: | - | - | - | - | Functionality was deprecated in version 3.0 |
27+
| Data validation using Great Expectations for streaming dataframes | [`FeatureGroup.validate()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/feature_group_api/#validate) <br/> [`FeatureGroup.insert_stream()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/feature_group_api/#insert_stream) | - | - | - | - | - | `insert_stream` does not perform any data validation even when a expectation suite is attached. |
28+
| Stream ingestion | [`FeatureGroup.insert_stream()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/feature_group_api/#insert_stream) | :white_check_mark: | - | :white_check_mark: | :white_check_mark: | :white_check_mark: | Python/Pandas/Polars has currently no notion of streaming. |
29+
| Reading from Streaming Storage Connectors | [`KafkaConnector.read_stream()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/storage_connector_api/#read_stream) | :white_check_mark: | - | - | - | - | Python/Pandas/Polars has currently no notion of streaming.
3030
For Flink/Beam/Java only write operations are supported |
31-
| Reading training data from external storage other than S3 | [`FeatureView.get_training_data()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/feature_view_api/#get_training_data) | :white_check_mark: | - | - | - | - | Reading training data that was written to external storage using a Storage Connector other than S3 can currently not be read using HSFS APIs, instead you will have to use the storage's native client. |
32-
| Reading External Feature Groups into Dataframe | [`ExternalFeatureGroup.read()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/external_feature_group_api/#read) | :white_check_mark: | - | - | - | - | Reading an External Feature Group directly into a Pandas/Polars Dataframe is not supported, however, you can use the [Query API](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/query_api/) to create Feature Views/Training Data containing External Feature Groups. |
33-
| Read Queries containing External Feature Groups into Dataframe | [`Query.read()`](<https://docs.hopsworks.ai/feature-store-api/{{{> hopsworks_version }}}/generated/api/query_api/#read) | :white_check_mark: | - | - | - | - | Reading a Query containing an External Feature Group directly into a Pandas/Polars Dataframe is not supported, however, you can use the Query to create Feature Views/Training Data and write the data to a Storage Connector, from where you can read up the data into a Pandas/Polars Dataframe. |
31+
| Reading training data from external storage other than S3 | [`FeatureView.get_training_data()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#get_training_data) | :white_check_mark: | - | - | - | - | Reading training data that was written to external storage using a Storage Connector other than S3 can currently not be read using HSFS APIs, instead you will have to use the storage's native client. |
32+
| Reading External Feature Groups into Dataframe | [`ExternalFeatureGroup.read()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/external_feature_group_api/#read) | :white_check_mark: | - | - | - | - | Reading an External Feature Group directly into a Pandas/Polars Dataframe is not supported, however, you can use the [Query API](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/query_api/) to create Feature Views/Training Data containing External Feature Groups. |
33+
| Read Queries containing External Feature Groups into Dataframe | [`Query.read()`](https://docs.hopsworks.ai/feature-store-api/{{{hopsworks_version}}}/generated/api/query_api/#read) | :white_check_mark: | - | - | - | - | Reading a Query containing an External Feature Group directly into a Pandas/Polars Dataframe is not supported, however, you can use the Query to create Feature Views/Training Data and write the data to a Storage Connector, from where you can read up the data into a Pandas/Polars Dataframe. |
3434

3535
## Python
3636

docs/user_guides/fs/data_source/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,4 +160,4 @@ Read more about training data creation [here](../feature_view/training-data.md).
160160
## Next Steps
161161

162162
We have gone through the basic use cases of a data source.
163-
For more details about the API functionality for any specific connector type, checkout the [API section](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/storage_connector_api/#storage-connector).
163+
For more details about the API functionality for any specific connector type, checkout the [API section](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/storage_connector_api/#storage-connector).

docs/user_guides/fs/feature_group/create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Using the HSFS API you can execute:
3939
)
4040
```
4141

42-
The full method documentation is available [here](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_group_api/#featuregroup).
42+
The full method documentation is available [here](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_group_api/#featuregroup).
4343
If you need to create a feature group with vector similarity search supported, refer to [this guide](../vector_similarity_search.md#extending-feature-groups-with-similarity-search). `name` is the only mandatory parameter of the `create_feature_group` and represents the name of the feature group.
4444

4545
In the example above we created the first version of a feature group named *weather*, we provide a description to make it searchable to the other project members, as well as making the feature group available online.
@@ -352,7 +352,7 @@ If a feature group is online enabled, the `insert` method will store the feature
352352

353353
### API Reference
354354

355-
[FeatureGroup](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_group_api/#featuregroup)
355+
[FeatureGroup](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_group_api/#featuregroup)
356356

357357
## Create using the UI
358358

docs/user_guides/fs/feature_group/create_external.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Once you have defined the metadata, you can
7777
fg.save()
7878
```
7979

80-
The full method documentation is available [here](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/external_feature_group_api/#externalfeaturegroup). `name` is a mandatory parameter of the `create_external_feature_group` and represents the name of the feature group.
80+
The full method documentation is available [here](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/external_feature_group_api/#externalfeaturegroup). `name` is a mandatory parameter of the `create_external_feature_group` and represents the name of the feature group.
8181

8282
The version number is optional, if you don't specify the version number the APIs will create a new version by default with a version number equals to the highest existing version number plus one.
8383

@@ -125,18 +125,18 @@ For an external feature group to be available online, during the creation of the
125125
```
126126

127127
The `insert()` method takes a DataFrame as parameter and writes it _only_ to the online feature store.
128-
Users can select which subset of the feature group data they want to make available on the online feature store by using the [query APIs](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/query_api/).
128+
Users can select which subset of the feature group data they want to make available on the online feature store by using the [query APIs](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/query_api/).
129129

130130
### Limitations
131131

132132
Hopsworks Feature Store does not support time-travel queries on external feature groups.
133133

134134
Additionally, support for `.read()` and `.show()` methods when using by the Python engine is limited to external feature groups defined on BigQuery and Snowflake and only when using the [Feature Query Service](../../../setup_installation/common/arrow_flight_duckdb.md).
135-
Nevertheless, external feature groups defined top of any data source can be used to create a training dataset from a Python environment invoking one of the following methods: [create_training_data](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_view_api/#create_training_data), [create_train_test_split](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_view_api/#create_train_test_split) or the [create_train_validation_test_split](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/feature_view_api/#create_train_validation_test_split)
135+
Nevertheless, external feature groups defined top of any data source can be used to create a training dataset from a Python environment invoking one of the following methods: [create_training_data](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#create_training_data), [create_train_test_split](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#create_train_test_split) or the [create_train_validation_test_split](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#create_train_validation_test_split)
136136

137137
### API Reference
138138

139-
[External FeatureGroup](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/external_feature_group_api/#externalfeaturegroup)
139+
[External FeatureGroup](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/external_feature_group_api/#externalfeaturegroup)
140140

141141
## Create using the UI
142142

docs/user_guides/fs/feature_group/create_spine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,4 @@ You just need to make sure it has the same schema.
6060

6161
### API Reference
6262

63-
[SpineGroup](<https://docs.hopsworks.ai/hopsworks-api/{{{> hopsworks_version }}}/generated/api/spine_group_api/#spinegroup)
63+
[SpineGroup](<https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/spine_group_api/#spinegroup)

0 commit comments

Comments
 (0)