Skip to content

Commit 9a42b49

Browse files
committed
Add Mars@Homem description to readme and examples
1 parent 4abc1b9 commit 9a42b49

35 files changed

+59
-16
lines changed

README.md

+59-16
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,6 @@
99

1010
Marsjs is the browser client for Mars@Home. Currently this extension labels image from [Unsplash](https://unsplash.com) in browser - using MobileNet on Tensorflow.Js. Install [Mars@Home from Chrome Store](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
1111

12-
## Project Structure
13-
14-
* [`captioner`](./captioner): Contains MobileNet & TensorflowJs code for Image Labeling
15-
* [`extension`](./extension): Contains code of Chrome Extension
16-
* [`images`](./images): Screenshots & media files for the README
17-
* [`logo-files`](./logo-files): Logo files for [Mars@Home](https://github.com/MarsAtHome/)
18-
1912
## Non-Developer quickstart
2013
Install [Mars@Home for Google Chrome](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
2114

@@ -27,6 +20,14 @@ Clone this project
2720
$ git clone https://github.com/MarsAtHome/marsjs
2821
```
2922

23+
### Project Structure
24+
25+
* [`captioner`](./captioner): Contains MobileNet & TensorflowJs code for Image Labeling
26+
* [`extension`](./extension): Contains code of Chrome Extension
27+
* [`images`](./images): Screenshots & media files for the README
28+
* [`logo-files`](./logo-files): Logo files for [Mars@Home](https://github.com/MarsAtHome/)
29+
30+
3031
#### In Firefox
3132
1. Go to `about:debugging` in Firefox
3233

@@ -41,24 +42,65 @@ $ git clone https://github.com/MarsAtHome/marsjs
4142

4243
**Check the Current task by clicking <img src="./logo-files/MarsAtHome.png?raw=true" width="24" height="24"> in your browser's url bar**
4344

45+
## Model (MobileNet)
46+
Taken straight from [tfjs-converter](https://github.com/tensorflow/tfjs-converter/tree/master/demo/mobilenet) MobileNet model is served from Google Cloud as 4MB chunks and is cacheable by browser.
47+
48+
The model takes 224x224 image, so Unsplash images are fetched in 224x224 size with `crop=face` URL parameter.
49+
50+
After changing files in `captioner/mobilenet/`, run
51+
52+
```
53+
$ cd captioner
54+
$ rmdir dist; # OR rm -rf dist
55+
$ parcel build mobilenet/index.html
56+
```
57+
58+
[Parcel](https://parceljs.org/) must be installed globally.
59+
60+
Copy all files except `index.html` from `dist` to `extension` directory. Copy the content of `dist/index.html` and paste it in `extension/popup.html` title & subtitle. Remove old code pointing to old build after pasting.
61+
62+
## Design
63+
64+
On clicking <img src="./logo-files/MarsAtHome.png?raw=true" width="24" height="24"> the extension appears as a box of 300x600. Shows the link to current photo being processed. Once the labels assigned, shows top 3 labels with their Confidence score on the left.
65+
66+
<p align="center">
67+
<img src="./images/ss5.png?raw=true">
68+
</p>
69+
4470
## Few Examples of Image Labeling
4571

46-
[![Screenshot Squirrel](./images/ss5.png?raw=true)](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
72+
<img src="./images/ss39-shop.png" align="left" width="282px"> <img src="./images/ss26-girl-mask.png" align="center" width="282px"> <img src="./images/ss15-cat-flag.png" align="right" width="282px">
73+
74+
<img src="./images/ss38-seashore-girl.png" align="left" width="282px"> <img src="./images/ss35-minibus.png" align="center" width="283px"> <img src="./images/ss41-llama.png" align="right" width="282px">
75+
76+
## Why image labeling?
77+
[Mars@Home](https://marsathome.org/) says it's a public volunteer computing project committed to solving real life problems. Then why the first client labels images instead of ["computing climate simulations"](https://marsathome.org/faqs.html)?
78+
79+
With this first version, we want to find out that *would people participate in a modern volunteer computing project for real life problems*? Keeping that in mind, we designed it so that, with other things, it has a small fun element to it. We wanted maximum people and developers to join the movement. Because the real development is yet to happen!
80+
81+
<hr>
82+
83+
### BTW I have to confess that building this project was such a joy! But watching the MobileNet model assign labels to beautiful Unsplash photos was equally entertaining. So here's more
84+
85+
<hr>
86+
87+
<img src="./images/ss12-fireman.png" align="left" width="282px"> <img src="./images/ss13-assassin-creed.png" align="center" width="282px"> <img src="./images/ss24-iguana.png" align="right" width="282px">
4788

48-
[![Screenshot Rose Hands](./images/ss3.png?raw=true)](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
89+
<img src="./images/ss30-palace.png" align="left" width="282px"> <img src="./images/ss31-couple.png" align="center" width="282px"> <img src="./images/ss27-tower-eiffel.png" align="right" width="282px">
4990

50-
[![Screenshot Spiral](./images/ss4.png?raw=true)](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
91+
<img src="./images/ss18-glasses-desert.png" align="left" width="282px"> <img src="./images/ss10-tricycle.png" align="center" width="282px"> <img src="./images/ss11-forest-road.png" align="right" width="282px">
5192

52-
[![Screenshot Cab](./images/ss6.png?raw=true)](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
93+
<img src="./images/ss16-wardrobe.png" align="left" width="282px"> <img src="./images/ss17-goose.png" align="center" width="282px"> <img src="./images/ss9-desert.png" align="right" width="282px">
5394

54-
[![Screenshot Balloon](./images/ss8.png?raw=true)](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
95+
<img src="./images/ss19-girl-street.png" align="left" width="282px"> <img src="./images/ss20-crab.png" align="center" width="282px"> <img src="./images/ss22-boat.png" align="right" width="282px">
5596

56-
[![Screenshot Alp](./images/ss7.png?raw=true)](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
97+
<img src="./images/ss23-fog-valley.png" align="left" width="282px"> <img src="./images/ss25-water-palace.png" align="center" width="282px"> <img src="./images/ss28-girl-farm.png" align="right" width="282px">
5798

58-
[![Screenshot Pole](./images/ss2.png?raw=true)](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
99+
<img src="./images/ss29-neck-brace.png" align="left" width="282px"> <img src="./images/ss32-cab.png" align="center" width="282px"> <img src="./images/ss33-concert.png" align="right" width="282px">
59100

60-
[![Screenshot Gazelle](./images/ss1.png?raw=true)](https://chrome.google.com/webstore/detail/marshome/dikaddifgkonkicimbgikbcbaagajjhj)
101+
<img src="./images/ss34-daisy.png" align="left" width="282px"> <img src="./images/ss36-laptop.png" align="center" width="282px"> <img src="./images/ss37-backpack.png" align="right" width="282px">
61102

103+
<img src="./images/ss40-clock.png" align="left" width="282px"> <img src="./images/ss42-feet.png" align="center" width="282px"> <img src="./images/ss43-dairy.png" align="right" width="282px">
62104

63105
## Libraries & Model used
64106

@@ -67,4 +109,5 @@ $ git clone https://github.com/MarsAtHome/marsjs
67109
* [MobileNet Ported to Tensorflow.js](https://github.com/tensorflow/tfjs-converter/tree/master/demo/mobilenet)
68110

69111
## Learn more about Mars@Home project
70-
Do visit → https://marsathome.org
112+
* Star this repository :)
113+
* Do visit → https://marsathome.org

images/ss10-tricycle.png

148 KB
Loading

images/ss11-forest-road.png

143 KB
Loading

images/ss12-fireman.png

130 KB
Loading

images/ss13-assassin-creed.png

152 KB
Loading

images/ss14-smoking-girl.png

167 KB
Loading

images/ss15-cat-flag.png

175 KB
Loading

images/ss16-wardrobe.png

158 KB
Loading

images/ss17-goose.png

153 KB
Loading

images/ss18-glasses-desert.png

143 KB
Loading

images/ss19-girl-street.png

157 KB
Loading

images/ss20-crab.png

88.7 KB
Loading

images/ss22-boat.png

158 KB
Loading

images/ss23-fog-valley.png

132 KB
Loading

images/ss24-iguana.png

121 KB
Loading

images/ss25-water-palace.png

146 KB
Loading

images/ss26-girl-mask.png

146 KB
Loading

images/ss27-tower-eiffel.png

142 KB
Loading

images/ss28-girl-farm.png

172 KB
Loading

images/ss29-neck-brace.png

167 KB
Loading

images/ss30-palace.png

129 KB
Loading

images/ss31-couple.png

94.3 KB
Loading

images/ss32-cab.png

140 KB
Loading

images/ss33-concert.png

154 KB
Loading

images/ss34-daisy.png

188 KB
Loading

images/ss35-minibus.png

143 KB
Loading

images/ss36-laptop.png

155 KB
Loading

images/ss37-backpack.png

111 KB
Loading

images/ss38-seashore-girl.png

154 KB
Loading

images/ss39-shop.png

181 KB
Loading

images/ss40-clock.png

69.7 KB
Loading

images/ss41-llama.png

118 KB
Loading

images/ss42-feet.png

151 KB
Loading

images/ss43-dairy.png

166 KB
Loading

images/ss9-desert.png

71.8 KB
Loading

0 commit comments

Comments
 (0)