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

Sync master to release #20

Merged
merged 25 commits into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
8851722
chore: Update language.md (#4412)
franciscojavierarceo Aug 15, 2024
721ec74
feat: Create ADOPTERS.md (#4410)
franciscojavierarceo Aug 16, 2024
0baeeb5
fix: Using repo_config parameter in teardown to allow for feature-sto…
danbaron63 Aug 16, 2024
cebbe04
feat: Updating docs to include model inference guidelines (#4416)
franciscojavierarceo Aug 16, 2024
23c6c86
fix: Retire pytz library (#4406)
shuchu Aug 16, 2024
160cd36
Update model-inference.md
franciscojavierarceo Aug 17, 2024
09b026b
chore: Auto-detect python version in Makefile (#4419)
tokoko Aug 17, 2024
d235832
fix: Default to pandas mode if not specified in ODFV proto in databas…
EXPEbdodla Aug 18, 2024
8181007
chore: Update SUMMARY.md (#4422)
franciscojavierarceo Aug 19, 2024
66a0a38
docs: Updated README template and fixed links to be consistent for HT…
dandawg Aug 19, 2024
d18d01d
fix: Add feast-operator Makefile to semantic-release script (#4424)
tchughesiv Aug 19, 2024
46655f0
feat: Add health check service to registry server (#4421)
EXPEbdodla Aug 19, 2024
1771f66
feat: Feast Security Model (aka RBAC) (#4380)
dmartinol Aug 21, 2024
75983f2
chore: Fix rbac url.
franciscojavierarceo Aug 21, 2024
0a48f7b
fix: Links to the RBAC documentation under Concepts and Components (#…
redhatHameed Aug 21, 2024
42d659f
docs: Reorganize registry docs (#4407)
tokoko Aug 23, 2024
7d744ad
chore: Update Slack link
franciscojavierarceo Aug 23, 2024
a2460d9
build: Set a proper build-system protobuf version (#4438)
Atry Aug 23, 2024
2ba93f6
Update README.md
franciscojavierarceo Aug 23, 2024
dda0088
fix: Typos related to k8s (#4442)
brijesh-vora-sp Aug 24, 2024
896360a
feat: Refactoring code to get oidc end points from discovery URL. (#4…
lokeshrangineni Aug 24, 2024
19cf222
chore: Mark tests using keycloak with xdist_group (#4436)
tokoko Aug 25, 2024
20290ce
fix: Locate feature_store.yaml from __file__ (#4443)
Atry Aug 25, 2024
34238d2
feat: Update roadmap.md (#4445)
franciscojavierarceo Aug 25, 2024
55a61e8
chore: Remove Rockset from feast (#4434)
tokoko Aug 26, 2024
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
Prev Previous commit
Next Next commit
docs: Updated README template and fixed links to be consistent for HT…
…ML (feast-dev#4423)

* chore: fixed README template to be consistent with current README

Signed-off-by: dandawg <12484302+dandawg@users.noreply.github.com>

* docs: markdown links consistency with html

Signed-off-by: dandawg <12484302+dandawg@users.noreply.github.com>

---------

Signed-off-by: dandawg <12484302+dandawg@users.noreply.github.com>
  • Loading branch information
dandawg authored Aug 19, 2024
commit 66a0a38e72b9ff67dde971e0e0b239e9cfa7f27b
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Thanks for sending a pull request! Here are some tips for you:

1. Ensure that your code follows our code conventions: https://github.com/feast-dev/feast/blob/master/CONTRIBUTING.md#code-style--linting
1. Ensure that your code follows our code conventions: https://github.com/feast-dev/feast/blob/master/CONTRIBUTING.md#code-style-and-linting
2. Run unit tests and ensure that they are passing: https://github.com/feast-dev/feast/blob/master/CONTRIBUTING.md#unit-tests
3. If your change introduces any API changes, make sure to update the integration tests here: https://github.com/feast-dev/feast/tree/master/sdk/python/tests
4. Make sure documentation is updated for your PR!
Expand Down
20 changes: 10 additions & 10 deletions docs/project/development-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
- [Pre-commit Hooks](#pre-commit-hooks)
- [Signing off commits](#signing-off-commits)
- [Incorporating upstream changes from master](#incorporating-upstream-changes-from-master)
- [Feast Python SDK / CLI](#feast-python-sdk--cli)
- [Feast Python SDK and CLI](#feast-python-sdk-and-cli)
- [Environment Setup](#environment-setup)
- [Code Style \& Linting](#code-style--linting)
- [Code Style and Linting](#code-style-and-linting)
- [Unit Tests](#unit-tests)
- [Integration Tests](#integration-tests)
- [Local integration tests](#local-integration-tests)
Expand All @@ -39,7 +39,7 @@
## Overview
This guide is targeted at developers looking to contribute to Feast components in
the main Feast repository:
- [Feast Python SDK / CLI](#feast-python-sdk--cli)
- [Feast Python SDK and CLI](#feast-python-sdk-and-cli)
- [Feast Java Serving](#feast-java-serving)

Please see [this page](../reference/codebase-structure.md) for more details on the structure of the entire codebase.
Expand Down Expand Up @@ -118,9 +118,9 @@ Our preference is the use of `git rebase [master]` instead of `git merge` : `git
Note that this means if you are midway through working through a PR and rebase, you'll have to force push:
`git push --force-with-lease origin [branch name]`

## Feast Python SDK / CLI
## Feast Python SDK and CLI
### Environment Setup
Setting up your development environment for Feast Python SDK / CLI:
Setting up your development environment for Feast Python SDK and CLI:
1. Ensure that you have Docker installed in your environment. Docker is used to provision service dependencies during testing, and build images for feature servers and other components.
- Please note that we use [Docker with BuiltKit](https://docs.docker.com/develop/develop-images/build_enhancements/).
- _Alternatively_ - To use [podman](https://podman.io/) on a Fedora or RHEL machine, follow this [guide](https://github.com/feast-dev/feast/issues/4190)
Expand Down Expand Up @@ -152,7 +152,7 @@ curl -fsSL https://pixi.sh/install.sh | bash
```sh
make lock-python-dependencies-all
```
9. Install development dependencies for Feast Python SDK / CLI. This will install package versions from the lock file, install editable version of feast and compile protobufs.
9. Install development dependencies for Feast Python SDK and CLI. This will install package versions from the lock file, install editable version of feast and compile protobufs.

If running inside a virtual environment:
```sh
Expand All @@ -169,8 +169,8 @@ make install-python-ci-dependencies-uv
docker build -t docker-whale -f ./sdk/python/feast/infra/feature_servers/multicloud/Dockerfile .
```

### Code Style & Linting
Feast Python SDK / CLI codebase:
### Code Style and Linting
Feast Python SDK and CLI codebase:
- Conforms to [Black code style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
- Has type annotations as enforced by `mypy`
- Has imports sorted by `ruff` (see [isort (I) rules](https://docs.astral.sh/ruff/rules/#isort-i))
Expand All @@ -190,15 +190,15 @@ make lint-python
> Setup [pre-commit hooks](#pre-commit-hooks) to automatically format and lint on commit.

### Unit Tests
Unit tests (`pytest`) for the Feast Python SDK / CLI can run as follows:
Unit tests (`pytest`) for the Feast Python SDK and CLI can run as follows:
```sh
make test-python-unit
```

> :warning: Local configuration can interfere with Unit tests and cause them to fail:
> - Ensure [no AWS configuration is present](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html)
> and [no AWS credentials can be accessed](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials) by `boto3`
> - Ensure Feast Python SDK / CLI is not configured with configuration overrides (ie `~/.feast/config` should be empty).
> - Ensure Feast Python SDK and CLI is not configured with configuration overrides (ie `~/.feast/config` should be empty).

### Integration Tests
There are two sets of tests you can run:
Expand Down
3 changes: 3 additions & 0 deletions infra/templates/README.md.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://github.com/feast-dev/feast/blob/master/LICENSE)
[![GitHub Release](https://img.shields.io/github/v/release/feast-dev/feast.svg?style=flat&sort=semver&color=blue)](https://github.com/feast-dev/feast/releases)

## Join us on Slack!
👋👋👋 [Come say hi on Slack!](https://join.slack.com/t/feastopensource/signup)

## Overview

Feast (**Fea**ture **St**ore) is an open source feature store for machine learning. Feast is the fastest path to manage existing infrastructure to productionize analytic data for model training and online inference.
Expand Down