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
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Everything is wrapped in Docker, here are the core packages used in *Sherlock*.
16
16
* Keras + Tensorflow
17
17
18
18
## 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.
20
20
21
21
## Setup environment
22
22
#### 1. Install Docker:
@@ -45,7 +45,7 @@ The package of Docker-CE for Mac already come with docker compose.
45
45
#### 3. Install Git:
46
46
[Install git](https://git-scm.com/downloads) for the appropriate system, if you don't have yet.
47
47
48
-
## Build and Start *Michaniki*
48
+
## Build and Start *Sherlock*
49
49
#### 1. Clone the repo:
50
50
51
51
```bash
@@ -71,7 +71,7 @@ echo $AWS_SECRET_ACCESS_KEY
71
71
Docker will access these environment variables and load them to docker.
72
72
73
73
#### 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:
*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`
105
105
106
106
#### 1. Welcome Page
107
107
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 \
119
119
-F model_name=base
120
120
```
121
121
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:
123
123
124
124
The model name *base* is used to refer to the basic InceptionV3 model.
125
125
@@ -155,9 +155,9 @@ The model name *base* is used to refer to the basic InceptionV3 model.
155
155
│ ├── class2
156
156
```
157
157
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.
159
159
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.
161
161
162
162
**The S3 folders should have public access permission**.
163
163
@@ -171,11 +171,11 @@ curl -X POST \
171
171
-F train_bucket_name=YOUR_BUCKET_NAME \
172
172
-F train_bucket_prefix=models/YOUR_MODEL_NAME
173
173
```
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.
175
175
176
176
#### 4. Labeling new images:
177
177
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:
0 commit comments