Clement Vachet commited on
Commit
4ab5c44
·
1 Parent(s): 6b1e33c

Add new github badges

Browse files
Files changed (1) hide show
  1. README.md +11 -6
README.md CHANGED
@@ -13,11 +13,15 @@ short_description: Object detection Lambda
13
  # Object detection via AWS Lambda
14
 
15
  [![](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
 
16
  [![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
17
  [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
18
 
 
 
 
19
 
20
- <b>Aim: AI-driven object detection task</b>
21
 
22
  Architecture:
23
  - Front-end: user interface via Gradio library
@@ -26,11 +30,12 @@ Architecture:
26
  You can try out our deployed [Hugging Face Space](https://huggingface.co/spaces/cvachet/object_detection_lambda
27
  )!
28
 
29
- <b>Table of contents: </b>
 
30
  - [Local development](#1-local-development)
31
  - [AWS deployment](#2-deployment-to-aws)
32
  - [Hugging Face deployment](#3-deployment-to-hugging-face)
33
-
34
 
35
  ## 1. Local development
36
 
@@ -54,7 +59,7 @@ bash
54
  ### 1.2. Execution via user interface
55
  Use of Gradio library for web interface
56
 
57
- <b>Note:</b> The environment variable ```AWS_API``` should point to the local container
58
  > export AWS_API=http://localhost:8080
59
 
60
  Command line for execution:
@@ -113,7 +118,7 @@ Example: ```object-detection-lambda```
113
 
114
  <details>
115
 
116
- <b>Steps</b>:
117
  - Create function from container image
118
 
119
  Example name: ```object-detection```
@@ -132,7 +137,7 @@ Advanced notes:
132
 
133
  <details>
134
 
135
- <b>Steps</b>:
136
  - Create a new ```Rest API``` (e.g. ```object-detection-api```)
137
  - Add a new resource to the API (e.g. ```/detect```)
138
  - Add a ```POST``` method to the resource
 
13
  # Object detection via AWS Lambda
14
 
15
  [![](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
16
+ [![Docker Pulls](https://img.shields.io/docker/pulls/cvachet/object-detection-lambda)](https://hub.docker.com/repository/docker/cvachet/object-detection-lambda)
17
  [![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
18
  [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
19
 
20
+ ![example workflow](https://github.com/clementsan/object_detection_lambda/actions/workflows/ci_python.yml/badge.svg)
21
+ ![example workflow](https://github.com/clementsan/object_detection_lambda/actions/workflows/publish_docker_image.yml/badge.svg)
22
+ ![example workflow](https://github.com/clementsan/object_detection_lambda/actions/workflows/sync_HFSpace.yml/badge.svg)
23
 
24
+ **Aim: AI-driven object detection task**
25
 
26
  Architecture:
27
  - Front-end: user interface via Gradio library
 
30
  You can try out our deployed [Hugging Face Space](https://huggingface.co/spaces/cvachet/object_detection_lambda
31
  )!
32
 
33
+ ----
34
+ **Table of contents:**
35
  - [Local development](#1-local-development)
36
  - [AWS deployment](#2-deployment-to-aws)
37
  - [Hugging Face deployment](#3-deployment-to-hugging-face)
38
+ ----
39
 
40
  ## 1. Local development
41
 
 
59
  ### 1.2. Execution via user interface
60
  Use of Gradio library for web interface
61
 
62
+ **Note:** The environment variable ```AWS_API``` should point to the local container
63
  > export AWS_API=http://localhost:8080
64
 
65
  Command line for execution:
 
118
 
119
  <details>
120
 
121
+ **Steps**:
122
  - Create function from container image
123
 
124
  Example name: ```object-detection```
 
137
 
138
  <details>
139
 
140
+ **Steps**:
141
  - Create a new ```Rest API``` (e.g. ```object-detection-api```)
142
  - Add a new resource to the API (e.g. ```/detect```)
143
  - Add a ```POST``` method to the resource