Skip to content

Commit

Permalink
[hotfix] Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
lindong28 committed Aug 7, 2023
1 parent a439fec commit 5e7e95e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ re-write Python programs into distributed stream or batch processing jobs.
observed feature ETL job patterns. These optimizations are automatically applied
to ETL jobs compiled from the declarative feature definitions, much like how SQL
optimizations are applied.
- **Assisted feature monitoring**: FeatHub provides [built-in
metrics](docs/content/metric-stores) to monitor the quality of features and
alert users to issues such as feature drift. This helps to improve the accuracy
and reliability of machine learning models.
- **Facilitated feature sharing**: FeatHub allows developers to register and
query feature definitions in a persistent [feature
registry](docs/content/registries). This capability reduces the duplication of
Expand All @@ -71,6 +67,11 @@ computation engine with milli-second latency. This provides better performance
than other open-source feature stores that only support feature generation
using Apache Spark.

- **Assisted feature monitoring**: FeatHub provides [built-in
metrics](docs/content/metric-stores) to monitor the quality of features and
alert users to issues such as feature drift. This helps to improve the accuracy
and reliability of machine learning models.

- **Stream-batch unified computation**: FeatHub allows for consistent feature
computation across offline, nearline, and online stacks using [Apache
Flink](docs/content/engines/flink.md) for real-time features with low latency,
Expand Down
7 changes: 7 additions & 0 deletions docs/content/metric-stores/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ It exposes the following metric-specific tags:
- filter_expr: The value of the filter_expr parameter.
- window_size_sec: The value of the window_size parameter in seconds.

See
[here](https://github.com/alibaba/feathub/blob/master/python/feathub/metric_stores/tests/test_prometheus_metric_store.py#L108)
for example usages.

## Ratio

Ratio is a metric that shows the proportion of the number features that meets
Expand All @@ -48,3 +52,6 @@ It exposes the following metric-specific tags:
- filter_expr: The value of the filter_expr parameter.
- window_size_sec: The value of the window_size parameter in seconds.

See
[here](https://github.com/alibaba/feathub/blob/master/python/feathub/metric_stores/tests/test_prometheus_metric_store.py#L122)
for example usages.

0 comments on commit 5e7e95e

Please sign in to comment.