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
{{ message }}
Repository navigation
Commit 2d9db4f
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/dev_guide/feathr_overall_release_guide.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ Once the release branch and release tag are created, the release pipelines will
75
75
76
76
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/).
77
77
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).
Copy file name to clipboardExpand all lines: docs/quickstart_local_sandbox.md
+29-22Lines changed: 29 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,12 @@ title: Quick Start Guide with Local Sandbox
7
7
8
8
We provide a local sandbox so users can use Feathr easily. The goal of the Feathr Sandbox is to:
9
9
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
13
13
- Interactive experience, usually try to run a job takes less than 1 min.
14
14
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.
16
16
17
17
The Sandbox is ideal for:
18
18
@@ -21,39 +21,47 @@ The Sandbox is ideal for:
21
21
22
22
## Getting Started
23
23
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:
25
27
26
28
```bash
27
29
docker run hello-world
28
30
```
29
31
32
+
You should see the `Hello from Docker!` message.
33
+
34
+
### Step 1: Start Sandbox
35
+
30
36
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.
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.
38
43
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.
40
45
41
46
`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.`
42
47
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.
After running the Notebooks, all the features will be registered in the UI, and you can visit the Feathr UI at:
51
59
52
60
```bash
53
61
http://localhost:8081
54
62
```
55
63
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.
57
65

58
66
59
67

@@ -64,21 +72,12 @@ The Feathr sandbox comes with:
64
72
- Built-in Jupyter Notebook
65
73
- Pre-installed data science packages such as `interpret` so that data science development becomes easy
66
74
- 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
70
77
- Feathr UI
71
-
- Feathr Registry API
78
+
-Local Feathr Registry API server backed by SQLite
72
79
- Local Redis server
73
80
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:
## Configuring Feathr Registry backend in Feathr Sandbox
83
82
84
83
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
109
108
110
109
### Feathr UI and Feathr Registry API Server development
111
110
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:
Copy file name to clipboardExpand all lines: docs/release-announcements/v1.0.0.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,18 +3,17 @@ layout: default
3
3
title: Announce Feathr 1.0.0
4
4
---
5
5
6
-
Announce Feathr 1.0.0
6
+
# Announce Feathr 1.0.0
7
7
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
9
9
10
-
New Features:
10
+
## New Features:
11
11
12
12
- 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.
13
13
14
14
- 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:
15
15
16
-
- Featurization source is only available at inference time.
17
-
16
+
- Featurization source is only available at inference time.
18
17
- Using offline transform might be a waste of storage and compute resources.
19
18
- Users would like to decouple featurization work off up-stream online system.
20
19
- Users would like to define transformation once for both online and offline consumption.
@@ -45,10 +44,10 @@ New Features:
45
44
46
45
- 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
47
46
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.
49
48
50
49
- 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.
51
50
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.
53
52
54
53
For more information, please refer to the official Feathr documentation.
0 commit comments