You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart.md
+36-17Lines changed: 36 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,23 +33,38 @@ We can bootstrap a feature repository using the `feast init` command:
33
33
```text
34
34
$ feast init
35
35
36
-
Generated feature_store.yaml and example features in example_repo.py
37
-
Now try running `feast apply` to apply and `feast materialize` to
38
-
sync data to the online store
36
+
Creating a new Feast repository in <...>/charmed_bass.
39
37
```
40
38
41
-
This command generates two files. Let's take a look at `feature_store.yaml`:
39
+
This command generates an example repository with a random name, containing the following files:
40
+
41
+
```text
42
+
.
43
+
└── charmed_bass
44
+
├── data
45
+
│ └── driver_stats.parquet
46
+
├── example.py
47
+
└── feature_store.yaml
48
+
```
49
+
50
+
Let's enter our example feature repository.
51
+
52
+
```
53
+
# replace "charmed_bass" with your auto-generated feature repository name
54
+
cd charmed_bass
55
+
```
56
+
57
+
Next, let's take a look at the `feature_store.yaml` file, which configures how the feature store runs.
42
58
43
59
```yaml
44
-
project: happy_ant
60
+
project: charmed_bass
45
61
registry: data/registry.db
46
62
provider: local
47
63
online_store:
48
-
local:
49
-
path: data/online_store.db
64
+
path: data/online_store.db
50
65
```
51
66
52
-
This file defines how the feature store is configured to run. The most important option here is `provider`, which specifies the environment that Feast will run in. We've initialized `provider=local`, indicating that Feast will run the feature store on our local machine. See [Repository Config](reference/feature-store-yaml.md) for more details.
67
+
An important field to be aware of is `provider`, which specifies the environment that Feast will run in. We've initialized `provider=local`, indicating that Feast will run the feature store on our local machine. See [Repository Config](reference/feature-store-yaml.md) for more details.
53
68
54
69
Next, take a look at `example.py`. This file defines some example features:
55
70
@@ -65,7 +80,7 @@ from feast.data_source import FileSource
65
80
# production, you can use your favorite DWH, such as BigQuery. See Feast documentation
* A `DataSource`, which is a pointer to persistent feature data. In this example, we're using a `FileSource`, which points to a set of parquet files on our local machine.
99
114
* An `Entity`, which is a metadata object that is used to organize and join features. In this example, our entity is `driver_id`, indicating that our features are modeling attributes of drivers.
@@ -106,7 +121,7 @@ We can register our features by running `feast apply` from the CLI.
106
121
```bash
107
122
$ feast apply
108
123
109
-
Processing <...>/feast-10-test-2/feast/example.py as example
124
+
Processing <...>/charmed_bass/example.py as example
@@ -166,14 +181,18 @@ This DataFrame contains all the necessary signals needed to train a model, exclu
166
181
167
182
### 4. Materializing features to the online store
168
183
169
-
We just used Feast to generate Using the `local` provider, the online store is a SQLite database. To materialize features, run the following command from the CLI:
184
+
We've just showed how we can use our features to train a model. Now, we'll populate the online store with our features to make them available for real time inference. When using the `local` provider, the online store is a SQLite database.
185
+
186
+
To materialize features, run the following command from the CLI:
170
187
171
188
```bash
172
189
# Materialize feature values up until the current time
We've just populated the online store with the most up-to-date features from the offline store. Our feature values are now ready for real-time fetching.
195
+
We've just populated the online store with the most up-to-date features from the offline store. Our feature values are now ready for real-time retrieval.
0 commit comments