Skip to content

Commit d436343

Browse files
authored
Merge pull request #148 from ml5js/cvalenzuela-patch-1
Updating logo and adding twitter badge to readme
2 parents bfd66fa + 30b19e3 commit d436343

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
# ![ML5](https://avatars1.githubusercontent.com/u/36965392?s=200&v=4)
1+
# ![ml5](https://user-images.githubusercontent.com/10605821/41332516-2ee26714-6eac-11e8-83e4-a40b8761e764.png)
2+
3+
[![CircleCI](https://img.shields.io/circleci/project/github/RedSparr0w/node-csgo-parser.svg?style=flat-square)](https://circleci.com/gh/ITPNYU/ml5) [![Version](https://img.shields.io/npm/v/ml5.svg?style=flat-square)](https://www.npmjs.com/package/ml5)
4+
[![Twitter Follow](https://img.shields.io/twitter/follow/espadrine.svg?style=social&label=Follow)](https://twitter.com/ml5js)
25

3-
[![CircleCI](https://img.shields.io/circleci/project/github/RedSparr0w/node-csgo-parser.svg?style=flat-square)](https://circleci.com/gh/ITPNYU/ml5) [![Version](https://img.shields.io/npm/v/ml5.svg?style=flat-square)](https://www.npmjs.com/package/ml5)
46

57

68
**_This project is currently in development._**
79

8-
### Friendly machine learning for the web!
10+
## Friendly machine learning for the web!
11+
12+
ml5.js aims to make machine learning accessible to a broad audience of artists, creative coders, and students. The library provides access to machine learning algorithms and models in the browser, building on top of [TensorFlow.js](https://js.tensorflow.org/) with no other external dependencies.
913

10-
ml5.js is a high level JavaScript library for machine learning. The main idea of this project is to further reduce the barriers between lower level machine learning and creative outputs using JavaScript.
14+
The library is supported by code examples, tutorials, and sample data sets with an emphasis on ethical computing. Bias in data, stereotypical harms, and responsible crowdsourcing are part of the documentation around data collection and usage.
1115

12-
It works by wrapping [tensorflow.js](https://js.tensorflow.org/), providing a simple and friendly interface to work with GPU accelerated machine learning in JavaScript.
16+
ml5.js is heavily inspired by [Processing](https://processing.org/) and [p5.js](https://p5js.org/).
1317

1418
## Usage
1519

@@ -25,19 +29,17 @@ or
2529

2630
## Resources
2731

28-
- [Getting Started](https://ml5js.org/docs/getting-started.html)
29-
- [API Reference](https://ml5js.org/docs/imagenet.html)
30-
- [Examples](https://ml5js.org/docs/simple-image-classification-example.html)
31-
- [Learn](https://ml5js.org/docs/glossary-statistics.html)
32-
- [Experiments](https://ml5js.org/en/experiments.html)
32+
- [Getting Started](https://ml5js.org/docs/getting-started)
33+
- [API Reference](https://ml5js.org/docs/ImageClassifier)
34+
- [Examples](https://ml5js.org/docs/quick-start)
35+
- [Learn](https://ml5js.org/docs/glossary-machine-learning)
36+
- [Experiments](https://ml5js.org/en/experiments)
3337

3438
## Standalone Examples
3539

36-
You can find a collection of examples using [ml5.js](https://github.com/ml5js/ml5-library) in the following repository:
37-
38-
[github.com/ml5js/ml5-examples](https://github.com/ml5js/ml5-examples).
40+
You can find a collection of standalone examples in this repository: [github.com/ml5js/ml5-examples](https://github.com/ml5js/ml5-examples)
3941

40-
The examples are meant to serve as an introduction to the library and machine learning concepts.
42+
These examples are meant to serve as an introduction to the library and machine learning concepts.
4143

4244
## Contributing
4345

0 commit comments

Comments
 (0)