Skip to content

Commit 9ebf604

Browse files
committed
Update readme with demo link
1 parent b0ec30c commit 9ebf604

File tree

8 files changed

+31
-29
lines changed

8 files changed

+31
-29
lines changed

README.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Intel Hackathon Prototype Implementation for our LEAP Platform
1010

11-
## A Brief of the Prototype:
11+
# A Brief of the Prototype:
1212

1313
#### INSPIRATION ![image](https://user-images.githubusercontent.com/72274851/218500470-ec078b99-0a50-4b06-a2df-c09e47ecc187.png)
1414

@@ -40,13 +40,13 @@ process.
4040
examiner conducting viva after each learning session. The AI examiner starts by asking question and always tries to motivate and provide
4141
hints to the student to arrive at correct answer, enhancing student engagement and motivation.
4242

43-
## Detailed LEAP Process Flow:
43+
# Detailed LEAP Process Flow:
4444

4545
![](./assets/Process-Flow.png)
4646

47-
## Tech Stack:
47+
# Technology Stack:
4848

49-
- Intel® oneAPI (Intel® AI Analytics Toolkit) Tech Stack
49+
- Intel® oneAPI (Intel® AI Analytics Toolkit) Tech Stack
5050

5151
![](./assets/Intel-Tech-Stack.png)
5252

@@ -56,23 +56,27 @@ hints to the student to arrive at correct answer, enhancing student engagement a
5656
4. Intel® distribution for Modin: Used for basic initial data analysis/EDA.
5757
5. Intel® optimized Python: Used for data pre-processing, reading etc.
5858

59-
- Base Tech Stack
59+
- Prototype App Tech Stack
6060

6161
![](./assets/Tech-Stack.png)
6262

63-
## Step-by-Step Code Execution Instructions:
63+
# Demo Video
6464

65-
a) Easy Option to Start Demo
65+
[![LEAP](https://img.youtube.com/vi/QoVWsOSlwvI/0.jpg)](https://www.youtube.com/watch?v=QoVWsOSlwvI)
66+
67+
# Step-by-Step Code Execution Instructions:
68+
69+
### Quick Setup Option
6670

6771
- Clone the Repository
68-
```console
72+
```python
6973
$ git clone https://github.com/rohitc5/intel-oneAPI/tree/main
7074
$ cd Intel-oneAPI
7175

7276
```
7377
- Start the LEAP RESTFul Service to consume both components (Ask Question/Doubt and Interactive Conversational AI Examiner) over API
7478

75-
```console
79+
```python
7680
$ cd api
7781

7882
# build the docker file
@@ -90,7 +94,7 @@ a) Easy Option to Start Demo
9094

9195
- Start the demo webapp build using streamlit
9296

93-
```console
97+
```python
9498
$ cd webapp
9599

96100
# build the docker file
@@ -103,12 +107,13 @@ a) Easy Option to Start Demo
103107
$ docker run -it -p 8502:8502 --name=leap-demo [IMAGE_ID]
104108

105109
```
110+
- Go to http://localhost:8502
106111

107-
b) Step-by-Step Option
112+
### Manual Setup Option
108113

109114
- Clone the Repository
110115

111-
```console
116+
```python
112117
$ git clone https://github.com/rohitc5/intel-oneAPI/tree/main
113118
$ cd Intel-oneAPI
114119

@@ -123,7 +128,7 @@ Here is the detailed architecture of `Ask Question/Doubt` component:
123128

124129
![](./assets/Ask-Doubt.png)
125130

126-
```console
131+
```python
127132
$ cd nlp/question_answering
128133

129134
# install dependencies
@@ -153,7 +158,7 @@ Here is the detailed architecture of `Ask Question/Doubt` component:
153158

154159
- Optimize using IPEX, Intel® Neural Compressor and run the bennchmark for comparison with Pytorch(Base)-FP32
155160

156-
```console
161+
```python
157162
# modify the params in pot_benchmark_qa.sh
158163
$ vi pot_benchmark_qa.sh
159164

@@ -190,14 +195,14 @@ Here is the detailed architecture of `Ask Question/Doubt` component:
190195

191196
- Run quick inference to test the model output
192197

193-
```console
198+
```python
194199
$ python run_qa_inference.py --model_name_or_path=[FP32 or INT8 finetuned model] --model_type=["vanilla_fp32" or "quantized_int8"] --do_lower_case --keep_accents --ipex_enable
195200

196201
```
197202

198203
- Train/Infer/Benchmark TFIDF Embedding model for Scikit-Learn (Base) vs Intel® Extension for Scikit-Learn
199204

200-
```console
205+
```python
201206
$ cd nlp/feature_extractor
202207

203208
# train (.fit_transform func), infer (.transform func) and perform benchmark
@@ -209,7 +214,7 @@ Here is the detailed architecture of `Ask Question/Doubt` component:
209214

210215
- Setup LEAP API
211216

212-
```console
217+
```python
213218
$ cd api
214219

215220
# install dependencies
@@ -252,7 +257,7 @@ Here for performance gain, we can use INT8 quantized model optimized using Intel
252257

253258
Please Note that for fun 😄, we also provide usage of Azure OpenAI Cognitive Service to use models like GPT3 paid subscription API. You just need to provide `azure_deployment_name` below configuration and `<your_key>`
254259

255-
```console
260+
```python
256261

257262
AI_EXAMINER_CONFIG = {
258263
"llm_name": "azure_gpt3",
@@ -273,7 +278,7 @@ Please Note that for fun 😄, we also provide usage of Azure OpenAI Cognitive S
273278

274279
- Start the API server
275280

276-
```console
281+
```python
277282
$ cd api/src/
278283

279284
# start the gunicorn server
@@ -282,7 +287,7 @@ Please Note that for fun 😄, we also provide usage of Azure OpenAI Cognitive S
282287

283288
- Start the Streamlit web UI demo
284289

285-
```console
290+
```python
286291
$ cd webapp
287292

288293
# install dependencies
@@ -296,19 +301,16 @@ Please Note that for fun 😄, we also provide usage of Azure OpenAI Cognitive S
296301

297302
# Benchmark Results with Intel® oneAPI AI Analytics Toolkit
298303

299-
- We have already added several benchmark results to compare how beneficial Intel® oneAPI AI Analytics Toolkit is compared to baseline. Please go to `benchmark` folder to view the results. Please Note that share results are
304+
- We have already added several benchmark results to compare how beneficial Intel® oneAPI AI Analytics Toolkit is compared to baseline. Please go to `benchmark` folder to view the results. Please Note that the shared results are based
300305
on provided Intel® Dev Cloud machine *(Intel Xeon Processor (Skylake, IBRS) - 10v CPUs 16GB RAM)*
301306

302-
# What I learned ![image](https://user-images.githubusercontent.com/72274851/218499685-e8d445fc-e35e-4ab5-abc1-c32462592603.png)
303-
307+
# What we learned ![image](https://user-images.githubusercontent.com/72274851/218499685-e8d445fc-e35e-4ab5-abc1-c32462592603.png)
304308

305-
![image](https://user-images.githubusercontent.com/72274851/220130227-3c48e87b-3e68-4f1c-b0e4-8e3ad9a4805a.png)
306309

307-
✅ Building application using Intel® AI Analytics Toolkit: The Intel® AI Analytics Toolkit gives data scientists, AI developers, and researchers familiar Python* tools and frameworks to accelerate end-to-end data science and analytics pipelines on Intel® architecture. The components are built using oneAPI libraries for low-level compute optimizations. This toolkit maximizes performance from preprocessing through deep learning, machine learning, and provides interoperability for efficient model development.
310+
![image](assets/Intel-ai-analytics-banner.png)
308311

309-
Easy to Adapt: The Intel® AI Analytics Toolkit requires minimal changes to adapt to a machine learning, deep learning workloads.
312+
Utilizing the Intel® AI Analytics Toolkit: By utilizing the Intel® AI Analytics Toolkit, developers can leverage familiar Python* tools and frameworks to accelerate the entire data science and analytics process on Intel® architecture. This toolkit incorporates oneAPI libraries for optimized low-level computations, ensuring maximum performance from data preprocessing to deep learning and machine learning tasks. Additionally, it facilitates efficient model development through interoperability.
310313

311-
Collaboration: Building a project like this likely required collaboration with a team of experts in various fields, such as deep learning, and data analysis, and I likely learned the importance of working together to achieve common goals.
314+
Seamless Adaptability: The Intel® AI Analytics Toolkit enables smooth integration with machine learning and deep learning workloads, requiring minimal modifications.
312315

313-
These are just a few examples of the knowledge and skills that i likely gained while building this project.
314-
Overall, building a helpful platform like LEAP is a challenging and rewarding experience that requires a combination of technical expertise and agricultural knowledge.
316+
✅ Fostered Collaboration: The development of such an application likely involved collaboration with a team comprising experts from diverse fields, including deep learning and data analysis. This experience likely emphasized the significance of collaborative efforts in attaining shared objectives.

assets/Intel-Tech-Stack.png

20.6 KB
Loading
86.2 KB
Loading

assets/Process-Flow.png

28.5 KB
Loading

ppt/.DS_Store

6 KB
Binary file not shown.
1.91 MB
Binary file not shown.
-2.09 MB
Binary file not shown.
28.5 KB
Loading

0 commit comments

Comments
 (0)