Skip to content

Commit 279e969

Browse files
Improve readability
1 parent bd6556e commit 279e969

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Everything is wrapped in Docker, here are the core packages used in *Sherlock*.
1616
* Keras + Tensorflow
1717

1818
## Transfer Learning Explained
19-
*Sherlock* does transfer learning and fine-tuning (two steps) on pre-trained deep CNNs using customize images. If you just want to setup *Sherlock*, skip to the next section.
19+
*Sherlock* does transfer learning and fine-tuning (two steps) on pre-trained deep CNNs on a custom image dataset. If you want to setup *Sherlock*, skip to the next section.
2020

2121
## Setup environment
2222
#### 1. Install Docker:
@@ -45,7 +45,7 @@ The package of Docker-CE for Mac already come with docker compose.
4545
#### 3. Install Git:
4646
[Install git](https://git-scm.com/downloads) for the appropriate system, if you don't have yet.
4747

48-
## Build and Start *Michaniki*
48+
## Build and Start *Sherlock*
4949
#### 1. Clone the repo:
5050

5151
```bash
@@ -71,7 +71,7 @@ echo $AWS_SECRET_ACCESS_KEY
7171
Docker will access these environment variables and load them to docker.
7272

7373
#### 3. Start the Docker Containers:
74-
move to the directory where you cloned *Sherlock* , and run:
74+
Move to the directory where you cloned *Sherlock* , and run:
7575
```bash
7676
docker-compose up --build
7777
```
@@ -87,7 +87,7 @@ Step 2/9 : RUN apt-get update && apt-get install -y --no-install-recommends apt-
8787
...
8888
```
8989

90-
The first time of building might take few minutes, once finished, you should see the *uWSGI* server, *inference* server running, something like this:
90+
The first time building might take few minutes. Once finished, you should see the *uWSGI* server, *inference* server running, something like this:
9191
```
9292
...
9393
michaniki_client_1 | *** uWSGI is running in multiple interpreter mode ***
@@ -101,7 +101,7 @@ michaniki_client_1 | spawned uWSGI worker 4 (pid: 24, cores: 2)
101101
Then *sherlock* is ready for you.
102102

103103
## Use *Sherlock*:
104-
*Sherlock* currently provides 3 major APIs. To test *Sherlock*, I recommend to test the APIs using [POSTMAN](https://www.getpostman.com/), while the examples below are in terminal, using `cURL`
104+
*Sherlock* currently provides 3 major APIs. To test *Sherlock*, I recommend testing the APIs using [POSTMAN](https://www.getpostman.com/). The examples below are in terminal, using `cURL`
105105

106106
#### 1. Welcome Page
107107
If *Sherlock* is running correctly, go to `http://127.0.0.1:3031/` in your web browser, you should see the welcome message of *Sherlock*.
@@ -119,7 +119,7 @@ curl -X POST \
119119
-F model_name=base
120120
```
121121

122-
replace the name after ``` image=@ ``` by the path of the image you want to run. *Sherlock* will return the image labels and probabilities, ranked from high to low, in `json` format:
122+
replace the name after ``` image=@ ``` with the path of the image you want to run. *Sherlock* will return the image labels and probabilities, ranked from high to low, in `json` format:
123123

124124
The model name *base* is used to refer to the basic InceptionV3 model.
125125

@@ -155,9 +155,9 @@ The model name *base* is used to refer to the basic InceptionV3 model.
155155
│ ├── class2
156156
```
157157

158-
The folder name you give to *YOUR_MODEL_NAME* will be used to identify this model once it get trained.
158+
The folder name you give to *YOUR_MODEL_NAME* will be used to identify this model once it is trained.
159159

160-
The name of train and val folders **can't be changed**. The folder names for different classes will be used as the label of the class, you can create any amount of class folders as you want.
160+
The name of train and val folders **can't be changed**. The folder names for different classes will be used as the label of the class, you can create as many class folders as you want.
161161

162162
**The S3 folders should have public access permission**.
163163

@@ -171,11 +171,11 @@ curl -X POST \
171171
-F train_bucket_name=YOUR_BUCKET_NAME \
172172
-F train_bucket_prefix=models/YOUR_MODEL_NAME
173173
```
174-
*Sherlock* will use the provided images to create a new model to classify the classes you provided in the S3 folder. Once the transfer learning is done, you can use the new model to label images by pass **YOUR_MODEL_NAME** to the inference API described earlier.
174+
*Sherlock* will use the provided images to create a new model to classify the classes you provided in the S3 folder. Once transfer learning is done, you can use the new model to label images by pass **YOUR_MODEL_NAME** to the inference API described earlier.
175175

176176
#### 4. Labeling new images:
177177

178-
Once the model transfer learning is finished, you can start to use the newly created model to label your new images. The new image folder should also be hosted in S3. The structure is pretty similar to the one used in the transfer learning API. Please structure your folder like this:
178+
Once transfer learning is finished, you can use the newly created model to label your new images. The new image folder should also be hosted in S3. The structure is pretty similar to the one used in the transfer learning API. Please structure your folder like this:
179179

180180
```
181181
.

0 commit comments

Comments
 (0)