Skip to content

Commit c36149e

Browse files
committed
Auto merge of #84 - abacon:readme-language, r=hobofan
docs/readme: fix some grammar issues in README.md I've done a little proofreading of the README to correct some small grammar issues and make it more readable.
2 parents ce8764e + 97c037f commit c36149e

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Caffe, Rust and numerous research papers and brings modularity, performance and
88
portability to deep learning. Leaf is lean and tries to introduce minimal
99
technical debt to your stack.
1010

11-
Leaf is a few months old, but thanks to its architecture and Rust already one of
11+
Leaf is a few months old, but thanks to its architecture and Rust, it is already one of
1212
the fastest Machine Intelligence Frameworks in the world.
1313

1414
<div align="center">
@@ -22,16 +22,16 @@ machines without one. Run it with OpenCL or CUDA. Credit goes to
2222
[Collenchyma][collenchyma] and Rust.
2323

2424
Leaf is part of the [Autumn][autumn] Machine Intelligence Platform, which is
25-
working on making AI algorithms 100x more computational efficient. Bringing
25+
working on making AI algorithms 100x more computational efficient. It seeks to bring
2626
real-time, offline AI to smartphones and embedded devices.
2727

2828
We see Leaf as the core of constructing high-performance machine intelligence
29-
applications. Leafs' design makes it easy to publish independent modules to make
29+
applications. Leaf's design makes it easy to publish independent modules to make
3030
e.g. deep reinforcement learning, visualization and monitoring, network
3131
distribution, [automated preprocessing][cuticula] or scaleable production
3232
deployment easily accessible for everyone.
3333

34-
For more info refer to,
34+
For more info, refer to
3535
* the [Leaf examples][leaf-examples],
3636
* the [Leaf Documentation][documentation],
3737
* the [Autumn Website][autumn] or
@@ -47,13 +47,13 @@ For more info refer to,
4747
[documentation]: http://autumnai.github.io/leaf
4848

4949
> Disclaimer: Leaf is currently in an early stage of development.
50-
> If you are experiencing any bugs that are not due to not yet implemented
51-
> features, feel free to create a issue.
50+
> If you are experiencing any bugs with features that have been
51+
> implemented, feel free to create a issue.
5252
5353
## Getting Started
5454

55-
If you are new to Rust you can install it as detailed [here][rust_download],
56-
and we recommend taking a look at the [official Getting Started Guide][rust_getting_started].
55+
If you are new to Rust you can install it as detailed [here][rust_download].
56+
We also recommend taking a look at the [official Getting Started Guide][rust_getting_started].
5757

5858
If you're using Cargo, just add Leaf to your `Cargo.toml`:
5959

@@ -94,7 +94,7 @@ others publish executable machine learning models build with Leaf. It features
9494
a CLI for easy usage and has a detailed guide in the [project
9595
README.md][leaf-examples].
9696

97-
And Leaf comes with an examples directory as well, which features popular neural
97+
Leaf comes with an examples directory as well, which features popular neural
9898
networks (e.g. Alexnet, Overfeat, VGG). To run them on your machine, just follow
9999
the install guide, clone this repoistory and then run
100100

@@ -107,7 +107,7 @@ cargo run --release --example benchmarks
107107

108108
## Ecosystem / Extensions
109109

110-
We design Leaf and the other crates of the [Autumn Platform][autumn] as modular
110+
We designed Leaf and the other crates of the [Autumn Platform][autumn] to be as modular
111111
and extensible as possible. More helpful crates you can use with Leaf:
112112

113113
- [**Cuticula**][cuticula]: Preprocessing Framework for Machine Learning
@@ -118,10 +118,10 @@ and extensible as possible. More helpful crates you can use with Leaf:
118118

119119
## Support / Contact
120120

121-
- With a bit of luck you find us online on the #rust-machine-learing IRC at irc.mozilla.org,
121+
- With a bit of luck, you can find us online on the #rust-machine-learing IRC at irc.mozilla.org,
122122
- but we are always approachable on [Gitter/Leaf][gitter-leaf]
123123
- For bugs and feature request, you can create a [Github issue][leaf-issue]
124-
- And for more private matters, send us a mail straight to our inbox developers@autumnai.com.
124+
- For more private matters, send us email straight to our inbox: developers@autumnai.com
125125
- Refer to [Autumn][autumn] for more information
126126

127127
[leaf-issue]: https://github.com/autumnai/leaf/issues
@@ -130,7 +130,7 @@ and extensible as possible. More helpful crates you can use with Leaf:
130130

131131
Want to contribute? Awesome! We have [instructions to help you get started][contributing].
132132

133-
Leaf has a near real-time collaboration culture and happens here on Github and
133+
Leaf has a near real-time collaboration culture, and it happens here on Github and
134134
on the [Leaf Gitter Channel][gitter-leaf].
135135

136136
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0
@@ -154,12 +154,12 @@ You can find the release history at the [CHANGELOG.md][changelog]. We are using
154154

155155
#### _Why Rust?_
156156

157-
The current hardware just recently became strong enough to support real-world
157+
Hardware has just recently become strong enough to support real-world
158158
usage of machine intelligence e.g. super-human image recognition, self-driving
159-
cars, etc.. For taking advantage of the computational power of the underlying
160-
hardware from GPUs to clusters you need a low-level language that allows for
159+
cars, etc. To take advantage of the computational power of the underlying
160+
hardware, from GPUs to clusters, you need a low-level language that allows for
161161
control of memory. But to make machine intelligence widely accessible you want
162-
to have a high-level comfortable abstraction over the underlying hardware.
162+
to have a high-level, comfortable abstraction over the underlying hardware.
163163

164164
Rust allows us to cross this chasm.
165165
Rust promises performance like C/C++ but with safe memory-control. For now we
@@ -169,9 +169,9 @@ that will make large, parallel learning networks over CPUs and GPUs more
169169
feasible and more reliable to develop. The development of these future libraries
170170
is already under way e.g. [Glium][glium].
171171

172-
On the usability side, Rust offers a trait-system, that makes it easy for
173-
researchers and hobbyists alike to extend and work with Leaf as if Leaf would
174-
have been written in a higher-level language such as Ruby, Python, Java, etc.
172+
On the usability side, Rust offers a trait-system that makes it easy for
173+
researchers and hobbyists alike to extend and work with Leaf as if it were
174+
written in a higher-level language such as Ruby, Python, or Java.
175175

176176
#### _Who can use Leaf?_
177177

@@ -184,14 +184,14 @@ developers alike.
184184
We believe strongly in machine intelligence and think that it will have a major
185185
impact on future innovations, products and our society. At Autumn, we experienced
186186
a lack of common and well engineered tools for machine learning and therefore
187-
started to create a modular toolbox for machine learning in Rust. We hope, that
188-
with making our work open source, we will speed-up research and development of
189-
production-ready applications and make their work easier as well.
187+
started to create a modular toolbox for machine learning in Rust. We hope that,
188+
by making our work open source, we will speed up research and development of
189+
production-ready applications and make that work easier as well.
190190

191191
#### _Who is Autumn?_
192192

193193
Autumn is a startup working on automated decision making. Autumn was started by
194-
two developers MJ and Max. The startup is located in Berlin and recently
194+
two developers, MJ and Max. The startup is located in Berlin and recently
195195
received a pre-seed investment from Axel Springer and Plug&Play.
196196

197197
[glium]: https://github.com/tomaka/glium

0 commit comments

Comments
 (0)