Skip to content

Commit 2d9db4f

Browse files
blrchenYuqing-cat
authored andcommitted
Improve Quickstart and Release Guide for v1.0.0 (feathr-ai#1107)
- Update the quickstart guide to make it easier for users to get started, validate feature definitions and develop new things
1 parent 646a845 commit 2d9db4f

4 files changed

Lines changed: 38 additions & 34 deletions

File tree

‎docs/README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
</h3>
1414
</html>
1515

16-
17-
1816
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://github.com/feathr-ai/feathr/blob/main/LICENSE)
1917
[![GitHub Release](https://img.shields.io/github/v/release/feathr-ai/feathr.svg?style=flat&sort=semver&color=blue)](https://github.com/feathr-ai/feathr/releases)
2018
[![Docs Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://feathr-ai.github.io/feathr/)
@@ -56,12 +54,12 @@ The easiest way to try out Feathr is to use the [Feathr Sandbox](https://feathr-
5654
docker run -it --rm -p 8888:8888 -p 8081:80 -p 7080:7080 -e GRANT_SUDO=yes feathrfeaturestore/feathr-sandbox:releases-v1.0.0
5755
```
5856

59-
And you can view default jupyter notebook:
57+
And you can view Feathr quickstart jupyter notebook:
6058
```bash
6159
http://localhost:8888/lab/workspaces/auto-w/tree/local_quickstart_notebook.ipynb
6260
```
6361

64-
After running the Notebooks, all the features will be registered in the UI, and you can visit the Feathr UI at:
62+
After running the notebook, all the features will be registered in the UI, and you can visit the Feathr UI at:
6563

6664
```bash
6765
http://localhost:8081

‎docs/dev_guide/feathr_overall_release_guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Once the release branch and release tag are created, the release pipelines will
7575

7676
3. Automated [workflow](https://github.com/feathr-ai/feathr/blob/main/.github/workflows/publish-to-maven.yml) for publishing runtime jar to [maven/sonatype repository](https://oss.sonatype.org/).
7777

78-
4. Automated [workflow](https://github.com/feathr-ai/feathr/blob/main/.github/workflows/publish-fat-jar.yml) for uploading runtime jar to [Azure storage](https://ms.portal.azure.com/#view/Microsoft_Azure_Storage/ContainerMenuBlade/~/overview/storageAccountId/%2Fsubscriptions%2Fa6c2a7cc-d67e-4a1a-b765-983f08c0423a%2FresourceGroups%2Fazurefeathrintegration%2Fproviders%2FMicrosoft.Storage%2FstorageAccounts%2Fazurefeathrstorage/path/public/etag/%220x8D9E6F64D62D599%22/defaultEncryptionScope/%24account-encryption-key/denyEncryptionScopeOverride//defaultId//publicAccessVal/Container).
78+
4. Automated [workflow](https://github.com/feathr-ai/feathr/blob/main/.github/workflows/publish-to-azure-storage.yml) for uploading runtime jar to [Azure storage](https://ms.portal.azure.com/#view/Microsoft_Azure_Storage/ContainerMenuBlade/~/overview/storageAccountId/%2Fsubscriptions%2Fa6c2a7cc-d67e-4a1a-b765-983f08c0423a%2FresourceGroups%2Fazurefeathrintegration%2Fproviders%2FMicrosoft.Storage%2FstorageAccounts%2Fazurefeathrstorage/path/public/etag/%220x8D9E6F64D62D599%22/defaultEncryptionScope/%24account-encryption-key/denyEncryptionScopeOverride//defaultId//publicAccessVal/Container).
7979

8080
## Release PyPI
8181

‎docs/quickstart_local_sandbox.md‎

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ title: Quick Start Guide with Local Sandbox
77

88
We provide a local sandbox so users can use Feathr easily. The goal of the Feathr Sandbox is to:
99

10-
- make it easier for users to get started,
11-
- make it easy to validate feature definitions and new ideas
12-
- make it easier for Feathr developers to setup environment and develop new things
10+
- Make it easier for users to get started,
11+
- Make it easy to validate feature definitions and new ideas
12+
- Make it easier for Feathr developers to setup environment and develop new things
1313
- Interactive experience, usually try to run a job takes less than 1 min.
1414

15-
As an end user, you can become productive in less than 5 mins and try out Feathr.
15+
As an end user, you can become productive in less than 5 minutes and try out Feathr.
1616

1717
The Sandbox is ideal for:
1818

@@ -21,39 +21,47 @@ The Sandbox is ideal for:
2121

2222
## Getting Started
2323

24-
First, make sure you have docker installed successfully on your machine by running this command:
24+
### Prerequisites
25+
26+
Make sure Docker is installed on your machine. You can find official installation guide [here]. (https://docs.docker.com/get-docker/#supported-platforms). To make sure Docker is successfully installed on your machine, run a test container as follows:
2527

2628
```bash
2729
docker run hello-world
2830
```
2931

32+
You should see the `Hello from Docker!` message.
33+
34+
### Step 1: Start Sandbox
35+
3036
To get started using Feathr, simply run the command below. Note that the image is around 5GB so it might take a while to pull it from DockerHub.
3137

3238
```bash
3339
# 80: Feathr UI, 8888: Jupyter, 7080: Interpret
3440
docker run -it --rm -p 8888:8888 -p 8081:80 -p 7080:7080 -e GRANT_SUDO=yes feathrfeaturestore/feathr-sandbox:releases-v1.0.0
3541
```
3642

37-
It should pop up a Jupyter link in `http://127.0.0.1:8888/`. Double click on the notebook file to start the Jupyter Notebook, and you should be able to see the Feathr sample notebook. Click the triangle button on the Jupyter notebook and the whole notebook will run locally.
3843

39-
If you see some errors like below, simply change the `-p 8081:80` part to `-p <new port>:80` so the Feathr UI will be redirected to the new port.
44+
If you see errors like below, simply change the `-p 8081:80` part to `-p <new port>:80` so the Feathr UI will be redirected to the new port.
4045

4146
`docker: Error response from daemon: driver failed programming external connectivity on endpoint hardcore_bose (ae107e924cddce6b942f96f2654369345b027ac82e5e44929a9f132e2af71746): Bind for 0.0.0.0:8081 failed: port is already allocated.`
4247

43-
The default jupyter notebook is here:
48+
### Step 2: Run Quickstart Sample Notebooks
49+
50+
Open jupyter notebook with below link and click the triangle button on the Jupyter notebook and the whole notebook will run locally.
4451
```bash
4552
http://localhost:8888/lab/workspaces/auto-w/tree/local_quickstart_notebook.ipynb
4653
```
4754

4855
![Feathr Notebook](./images/feathr-sandbox.png)
4956

57+
### Step 3: Browse Features in Feathr UI
5058
After running the Notebooks, all the features will be registered in the UI, and you can visit the Feathr UI at:
5159

5260
```bash
5361
http://localhost:8081
5462
```
5563

56-
After executing those scripts, you should be able to see a project called `local_spark` in the Feathr UI. You can also view lineage in the Feathr UI and explore all the details.
64+
You should be able to see a project called `product_recommendation` created in the Feathr UI. You can also view lineage in the Feathr UI and explore all the details.
5765
![Feathr UI](./images/feathr-sandbox-ui.png)
5866

5967
![Feathr UI](./images/feathr-sandbox-lineage.png)
@@ -64,21 +72,12 @@ The Feathr sandbox comes with:
6472
- Built-in Jupyter Notebook
6573
- Pre-installed data science packages such as `interpret` so that data science development becomes easy
6674
- Pre-installed Feathr package
67-
- A local spark environment for dev/test purpose
68-
- Feathr samples that can run locally
69-
- A local Feathr registry backed by SQLite
75+
- Local spark environment for dev/test purpose
76+
- Feathr quickstart notebook sample that can run locally
7077
- Feathr UI
71-
- Feathr Registry API
78+
- Local Feathr Registry API server backed by SQLite
7279
- Local Redis server
7380

74-
## Build Feathr Sandbox Docker Image
75-
76-
If you want to build the Feathr sandbox, run the below command in the Feathr root directory:
77-
78-
```bash
79-
docker build -f FeathrSandbox.Dockerfile -t feathrfeaturestore/feathr-sandbox .
80-
```
81-
8281
## Configuring Feathr Registry backend in Feathr Sandbox
8382

8483
By default, Feathr Sandbox uses a SQLite backend in Feathr registry, and the content will be deleted if you restart the container. If you want to use a persistent registry, say a remote MySQL database or SQL Server, you can configure an environment variable when starting the Feathr Sandbox container like below, by specifying `FEATHR_SANDBOX_REGISTRY_URL` environment variable:
@@ -109,4 +108,12 @@ In the future, an VSCode Server might be installed so that you can do interactiv
109108

110109
### Feathr UI and Feathr Registry API Server development
111110

112-
When packaging the Feathr Sandbox docker image, Feathr automatically builds the latest UI and Registry server code, and put them into the right folder of the Feathr Sandbox images.
111+
When packaging the Feathr Sandbox docker image, Feathr automatically builds the latest UI and Registry server code, and put them into the right folder of the Feathr Sandbox images.
112+
113+
### Build Feathr Sandbox Docker Image
114+
115+
If you want to build the Feathr sandbox, run the below command in the Feathr root directory:
116+
117+
```bash
118+
docker build -f FeathrSandbox.Dockerfile -t feathrfeaturestore/feathr-sandbox .
119+
```

‎docs/release-announcements/v1.0.0.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,17 @@ layout: default
33
title: Announce Feathr 1.0.0
44
---
55

6-
Announce Feathr 1.0.0
6+
# Announce Feathr 1.0.0
77

8-
Feathr 1.0.0-rc1 is released on February 16, 2023 with following new features
8+
Feathr 1.0.0 is released on February 28, 2023, with following new features
99

10-
New Features:
10+
## New Features:
1111

1212
- Feathr sandbox: The Feathr sandbox is a pre-configured environment that you can use to learn how to use Feathr, experiment with features, and build proof-of-concept applications locally, without setting up complex infrastructure on the cloud. Please check out [Quick Start Guide with Local Sandbox](https://feathr-ai.github.io/feathr/quickstart_local_sandbox.html) to get started.
1313

1414
- Online Transform: Online Transform is a feature that enables real-time feature transformations as part of the feature retrieval process, here are some use cases examples:
1515

16-
- Featurization source is only available at inference time​.
17-
16+
- Featurization source is only available at inference time.
1817
- Using offline transform might be a waste of storage and compute resources.
1918
- Users would like to decouple featurization work off up-stream online system.
2019
- Users would like to define transformation once for both online and offline consumption. 
@@ -45,10 +44,10 @@ New Features:
4544

4645
- Use SparkSQL as DataSource, code sample can be found at https://github.com/feathr-ai/feathr/blob/main/feathr_project/test/test_spark_sql_source.py
4746

48-
- Time pattern support in data source path. Please check [Input File for Feathr](https://feathr-ai.github.io/feathr/how-to-guides/feathr-input-format.html#timepartitionpattern-for-input-files) for more details.
47+
- Time pattern support in data source path. Please check [Input File for Feathr](https://feathr-ai.github.io/feathr/how-to-guides/feathr-input-format.html#timepartitionpattern-for-input-files) for more details.
4948

5049
- Feature names conflicts check and auto correction, please check [Getting Offline Features using Feature Query](https://feathr-ai.github.io/feathr/concepts/get-offline-features.html#feature-names-conflicts-check) for more details.
5150

52-
- Feathr MLOps V2 integration with Terrarform Deployment. Please see [Feathr MLOps V2 Integration Deployment Guide](https://github.com/Azure/mlops-v2/blob/feature/feathr/documentation/deployguides/deployguide_fs_ado.md) for more details.
51+
- Feathr MLOps V2 integration with Terraform Deployment. Please see [Feathr MLOps V2 Integration Deployment Guide](https://github.com/Azure/mlops-v2/blob/feature/feathr/documentation/deployguides/deployguide_fs_ado.md) for more details.
5352

5453
For more information, please refer to the official Feathr documentation.

0 commit comments

Comments
 (0)