Skip to content

Commit 9808bde

Browse files
authored
README.md: Some npm config commands no longer work (#906)
1 parent 2268193 commit 9808bde

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ npm install brain.js
8686

8787
### Installation note
8888

89-
`Brain.js` depends on a native module `headless-gl` for gpu support. In most cases installing `brain.js` from npm should just work. However, if you run into problems, this mean prebuilt binaries are not able to download from github repositories and you might need to build it yourself.
89+
`Brain.js` depends on a native module [`headless-gl`](https://www.npmjs.com/package/headless-gl) for GPU support. In most cases installing `brain.js` from npm should just work. However, if you run into problems, this means prebuilt binaries are not able to download from GitHub repositories and you might need to build it yourself.
9090

9191
#### Building from source
9292

@@ -100,30 +100,30 @@ npm rebuild
100100

101101
###### Mac OS X
102102

103-
- [Python 3.7 or later](https://www.python.org/)
103+
- [A supported version of Python](https://devguide.python.org/versions)
104104
- [XCode](https://developer.apple.com/xcode/)
105105

106106
###### Ubuntu/Debian
107107

108-
- [Python 3.7 or later](https://www.python.org/)
108+
- [A supported version of Python](https://devguide.python.org/versions)
109109
- A GNU C++ environment (available via the `build-essential` package on `apt`)
110110
- [libxi-dev](http://www.x.org/wiki/)
111-
- Working and up to date OpenGL drivers
111+
- Working and up-to-date OpenGL drivers
112112
- [GLEW](http://glew.sourceforge.net/)
113113
- [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)
114114

115115
```bash
116-
sudo apt-get install -y build-essential libxi-dev libglu1-mesa-dev libglew-dev pkg-config
116+
sudo apt-get install -y build-essential libglew-dev libglu1-mesa-dev libxi-dev pkg-config
117117
```
118118

119119
###### Windows
120120

121-
- [Python 3.7 or later](https://www.python.org/)
121+
- [A supported version of Python](https://devguide.python.org/versions) __See:__ https://apps.microsoft.com/store/search/python
122122
- [Microsoft Visual Studio Build Tools 2022](https://visualstudio.microsoft.com/downloads)
123-
- run in cmd: `npm config set msvs_version 2022`
124-
- run in cmd: `npm config set python python3`
123+
- run in cmd: `npm config set msvs_version 2022` __Note: This no longer works in modern versions of npm.__
124+
- run in cmd: `npm config set python python3` __Note: This no longer works in modern versions of npm.__
125125

126-
\* If you are using `Build Tools 2017` then run `npm config set msvs_version 2017`
126+
\* If you are using `Build Tools 2017` then run `npm config set msvs_version 2017` __Note: This no longer works in modern versions of npm.__
127127

128128
## Examples
129129

@@ -141,7 +141,7 @@ const config = {
141141
leakyReluAlpha: 0.01, // supported for activation type 'leaky-relu'
142142
};
143143

144-
// create a simple feed forward neural network with backpropagation
144+
// create a simple feed-forward neural network with backpropagation
145145
const net = new brain.NeuralNetwork(config);
146146

147147
net.train([
@@ -191,7 +191,7 @@ However, there is no reason to use a neural network to figure out XOR. (-: So, h
191191

192192
[Brain.js Examples Repo](https://github.com/BrainJS/brain.js-examples)
193193

194-
You can check out this fantastic screencast, which explains how to train a simple neural network using a real world dataset: [How to create a neural network in the browser using Brain.js](https://scrimba.com/c/c36zkcb).
194+
You can check out this fantastic screencast, which explains how to train a simple neural network using a real-world dataset: [How to create a neural network in the browser using Brain.js](https://scrimba.com/c/c36zkcb).
195195

196196
## Training
197197

@@ -338,7 +338,7 @@ net.train(data, {
338338

339339
The network will stop training whenever one of the two criteria is met: the training error has gone below the threshold (default `0.005`), or the max number of iterations (default `20000`) has been reached.
340340

341-
By default training will not let you know how it's doing until the end, but set `log` to `true` to get periodic updates on the current training error of the network. The training error should decrease every time. The updates will be printed to console. If you set `log` to a function, this function will be called with the updates instead of printing to the console.
341+
By default, training will not let you know how it's doing until the end, but set `log` to `true` to get periodic updates on the current training error of the network. The training error should decrease every time. The updates will be printed to the console. If you set `log` to a function, this function will be called with the updates instead of printing to the console.
342342
However, if you want to use the values of the updates in your own output, the `callback` can be set to a function to do so instead.
343343

344344
The learning rate is a parameter that influences how quickly the network trains. It's a number from `0` to `1`. If the learning rate is close to `0`, it will take longer to train. If the learning rate is closer to `1`, it will train faster, but training results may be constrained to a local minimum and perform badly on new data.(_Overfitting_) The default learning rate is `0.3`.

0 commit comments

Comments
 (0)