├── .gitignore ├── LICENSE ├── README.md ├── index.html ├── index.js ├── model.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | # System Files 107 | Thumbs.db 108 | .DS_Store 109 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Time Series Forecasting with TensorFlow.js 2 | 3 | > Pull stock prices from online API and perform predictions using Long Short Term Memory (LSTM) with TensorFlow.js framework 4 | 5 | ![cover](https://jinglescode.github.io/assets/img/posts/time-series-00.jpg) 6 | 7 | Machine learning is becoming increasingly popular these days and a growing number of the world’s population see it is as a magic crystal ball: predicting when and what will happen in the future. This experiment uses artificial neural networks to reveal stock market trends and demonstrates the ability of time series forecasting to predict future stock prices based on past historical data. [See also: [Predicting Stock Prices with PyTorch](https://github.com/jinglescode/time-series-forecasting-pytorch)] 8 | 9 | Disclaimer: As stock markets fluctuation are dynamic and unpredictable owing to multiple factors, this experiment is 100% educational and by no means a trading prediction tool. 10 | 11 | [Explore Demo](https://jinglescode.github.io/time-series-forecasting-tensorflowjs/) 12 | 13 | --- 14 | 15 | # Table of contents 16 | 17 | **[Project Walkthrough](#project-walkthrough)** 18 | - [Get Stocks Data](#get-stocks-data) 19 | - [Simple Moving Average](#simple-moving-average) 20 | - [Training Data](#training-data) 21 | - [Train Neural Network](#train-neural-network) 22 | - [Validation](#validation) 23 | - [Prediction](#prediction) 24 | - [Why isn't my Model Performing?](#why-isnt-my-model-performing) 25 | - [Conclusion](#conclusion) 26 | 27 | **[Contribute](#contribute)** 28 | 29 | **[License](#license)** 30 | 31 | --- 32 | 33 | # Project Walkthrough 34 | There are 4 parts to this project walkthrough: 35 | 1. Get stocks data from online API 36 | 2. Compute simple moving average for a given time window 37 | 3. Train LSTM neural network 38 | 4. Predict and compare predicted values to the actual values 39 | 40 | ## Get Stocks Data 41 | 42 | Before we can train the neural network and make any predictions, we will first require data. The type of data we are looking for is time series: a sequence of numbers in chronological order. A good place to fetch these data is the [Alpha Vantage Stock API](https://www.alphavantage.co/). This API allows us to retrieve chronological data on specific company stocks prices from the last 20 years. You may also refer to [this article](https://medium.com/@patrick.collins_58673/stock-api-landscape-5c6e054ee631) that explains adjusted stock prices, which is an important technical concept for working with historical market data. 43 | 44 | You can either pick [daily adjusted](https://www.alphavantage.co/documentation/#dailyadj) or [weekly adjusted](https://www.alphavantage.co/documentation/#weeklyadj), open/high/low/close/volume values, adjusted close values, and historical split/dividend events of the global equity specified, covering 20+ years of historical data. As suggested by [desduvauchelle](https://github.com/jinglescode/time-series-forecasting-tensorflowjs/issues/4), using adjusted close price is more robust to stock split compared to using closing price. 45 | 46 | The API yields the following fields: 47 | - open price 48 | - the highest price of that day 49 | - the lowest price of that day 50 | - closing price 51 | - adjusted close price (this is used in this project) 52 | - volume 53 | 54 | To prepare training dataset for our neural network, we will be using adjusted close stocks price. This also means that we will be aiming to predict the future closing price. Below graph shows 20 years of Microsoft Corporation weekly closing prices. 55 | 56 | ![20 years of Microsoft Corporation weekly closing prices data from alphavantage.co](https://jinglescode.github.io/assets/img/posts/time-series-01.jpg) 57 | 58 | ## Simple Moving Average 59 | 60 | For this experiment, we are using [supervised learning](https://en.wikipedia.org/wiki/Supervised_learning), which means feeding data to the neural network and it learns by mapping input data to the output label. One way to prepare the training dataset is to extract the moving average from that time-series data. 61 | 62 | [Simple Moving Average (SMA)](https://www.investopedia.com/terms/s/sma.asp) is a method to identify trends direction for a certain period of time, by looking at the average of all the values within that time window. The number of prices in a time window is selected experimentally. 63 | 64 | For example, let’s assume the closing prices for the past 5 days were 13, 15, 14, 16, 17, the SMA would be (13+15+14+16+17)/5 = 15. So the input for our training dataset is the set of prices within a single time window, and its label is the computed moving average of those prices. 65 | 66 | Let’s compute the SMA of Microsoft Corporation weekly closing prices data, with a window size of 50. 67 | 68 | ```javascript 69 | function ComputeSMA(data, window_size) 70 | { 71 | let r_avgs = [], avg_prev = 0; 72 | for (let i = 0; i <= data.length - window_size; i++){ 73 | let curr_avg = 0.00, t = i + window_size; 74 | for (let k = i; k < t && k <= data.length; k++){ 75 | curr_avg += data[k]['price'] / window_size; 76 | } 77 | r_avgs.push({ set: data.slice(i, i + window_size), avg: curr_avg }); 78 | avg_prev = curr_avg; 79 | } 80 | return r_avgs; 81 | } 82 | ``` 83 | 84 | And this is what we get, weekly stock closing price in blue, and SMA in orange. Because SMA is the moving average of 50 weeks, it is smoother than the weekly price, which can fluctuate. 85 | 86 | ![Simple Moving Average of Microsoft Corporation closing prices data](https://jinglescode.github.io/assets/img/posts/time-series-02.jpg) 87 | 88 | ## Training Data 89 | 90 | We can prepare the training data with weekly stock prices and the computed SMA. Given the window size is 50, this means that we will use the closing price of every 50 consecutive weeks as our training features (X), and the SMA of those 50 weeks as our training label (Y). Which [looks like that](https://gist.github.com/jinglescode/60f8f9357b3960a1b3017d7483f8194c). 91 | 92 | Next, we split our data into 2 sets, training and validation set. If 70% of the data is used for training, then 30% for validation. The API returns us approximate 1000 weeks of data, so 700 for training, and 300 for validation. 93 | 94 | ## Train Neural Network 95 | 96 | Now that the training data is ready, it is time to create a model for time series prediction, to achieve this we will use [TensorFlow.js](https://www.tensorflow.org/js) framework. TensorFlow.js is a library for developing and training machine learning models in JavaScript, and we can deploy these machine learning capabilities in a web browser. 97 | 98 | [Sequential model](https://js.tensorflow.org/api/latest/#sequential) is selected which simply connects each layer and pass the data from input to the output during the training process. In order for the model to learn time series data which are sequential, [recurrent neural network (RNN)](https://js.tensorflow.org/api/latest/#layers.rnn) layer is created and a number of [LSTM cells](https://js.tensorflow.org/api/latest/#layers.lstmCell) are added to the RNN. 99 | 100 | The model will be trained using [Adam](https://js.tensorflow.org/api/latest/#train.adam) ([research paper](https://arxiv.org/abs/1412.6980)), a popular optimisation algorithm for machine learning. [Root mean square error](https://js.tensorflow.org/api/latest/#losses.meanSquaredError) which will determine the difference between predicted values and the actual values, so the model is able to learn by minimising the error during the training process. 101 | 102 | Here is a code snippet of the model described above, [full code on Github](https://github.com/jinglescode/demos/tree/master/src/app/components/tfjs-timeseries-stocks). 103 | 104 | ```javascript 105 | async function trainModel(inputs, outputs, trainingsize, window_size, n_epochs, learning_rate, n_layers, callback){ 106 | 107 | const input_layer_shape = window_size; 108 | const input_layer_neurons = 100; 109 | 110 | const rnn_input_layer_features = 10; 111 | const rnn_input_layer_timesteps = input_layer_neurons / rnn_input_layer_features; 112 | 113 | const rnn_input_shape = [rnn_input_layer_features, rnn_input_layer_timesteps]; 114 | const rnn_output_neurons = 20; 115 | 116 | const rnn_batch_size = window_size; 117 | 118 | const output_layer_shape = rnn_output_neurons; 119 | const output_layer_neurons = 1; 120 | 121 | const model = tf.sequential(); 122 | 123 | let X = inputs.slice(0, Math.floor(trainingsize / 100 * inputs.length)); 124 | let Y = outputs.slice(0, Math.floor(trainingsize / 100 * outputs.length)); 125 | 126 | const xs = tf.tensor2d(X, [X.length, X[0].length]).div(tf.scalar(10)); 127 | const ys = tf.tensor2d(Y, [Y.length, 1]).reshape([Y.length, 1]).div(tf.scalar(10)); 128 | 129 | model.add(tf.layers.dense({units: input_layer_neurons, inputShape: [input_layer_shape]})); 130 | model.add(tf.layers.reshape({targetShape: rnn_input_shape})); 131 | 132 | let lstm_cells = []; 133 | for (let index = 0; index < n_layers; index++) { 134 | lstm_cells.push(tf.layers.lstmCell({units: rnn_output_neurons})); 135 | } 136 | 137 | model.add(tf.layers.rnn({ 138 | cell: lstm_cells, 139 | inputShape: rnn_input_shape, 140 | returnSequences: false 141 | })); 142 | 143 | model.add(tf.layers.dense({units: output_layer_neurons, inputShape: [output_layer_shape]})); 144 | 145 | model.compile({ 146 | optimizer: tf.train.adam(learning_rate), 147 | loss: 'meanSquaredError' 148 | }); 149 | 150 | const hist = await model.fit(xs, ys, 151 | { batchSize: rnn_batch_size, epochs: n_epochs, callbacks: { 152 | onEpochEnd: async (epoch, log) => { 153 | callback(epoch, log); 154 | } 155 | } 156 | }); 157 | 158 | return { model: model, stats: hist }; 159 | } 160 | ``` 161 | 162 | These are the [hyper-parameters](https://en.wikipedia.org/wiki/Hyperparameter_(machine_learning)) (parameters used in the training process) available for tweaking in the [frontend](https://jinglescode.github.io/demos/tfjs-timeseries-stocks): 163 | - Training Dataset Size (%): the amount of data used for training, and remaining data will be used for validation 164 | - Epochs: number of times the dataset is used to train the model ([learn more](https://machinelearningmastery.com/difference-between-a-batch-and-an-epoch/)) 165 | - Learning Rate: the amount of change in the weights during training in each step ([learn more](https://machinelearningmastery.com/learning-rate-for-deep-learning-neural-networks/)) 166 | - Hidden LSTM Layers: to increase the model complexity to learn in higher dimensional space ([learn more](https://machinelearningmastery.com/how-to-configure-the-number-of-layers-and-nodes-in-a-neural-network/)) 167 | 168 | ![Web frontend, showing parameters available for tweaking](https://jinglescode.github.io/assets/img/posts/time-series-03.jpg) 169 | 170 | Click the Begin Training Model button… 171 | 172 | ![User interface showing training model progress](https://jinglescode.github.io/assets/img/posts/time-series-04.jpg) 173 | 174 | The model seems to converge at around 15 epoch. 175 | 176 | ## Validation 177 | 178 | Now that the model is trained, it is time to use it for predicting future values, for our case, it is the moving average. We will use the model.predict function from TFJS. 179 | 180 | The data has been split into 2 sets, training and validation set. The training set has been used for training the model, thus will be using the validation set to validate the model. Since the model has not seen the validation dataset, it will be good if the model is able to predict values that are close to the true values. 181 | 182 | So let us use the remaining data for prediction which allow us to see how closely our predicted values are compared to the actual values. 183 | 184 | ![The green line denotes the prediction of the validation data, from web demo](https://jinglescode.github.io/assets/img/posts/time-series-05.jpg) 185 | 186 | Looks like the model predicted (green line) does a good job plotting closely to the actual price (blue line). This means that the model is able to predict the last 30% of the data which was unseen by the model. 187 | 188 | Other algorithms can be applied and uses the [Root Mean Square Error](https://www.statisticshowto.datasciencecentral.com/rmse/) to compare 2 or more models performance. 189 | 190 | ## Prediction 191 | 192 | Finally, the model has been validated and the predicted values map closely to its true values, we shall use it to predict the future. We will apply the same model.predict function and use the last 50 data points as the input, because our window size is 50. Since our training data is increment daily, we will use the past 50 days as input, to predict the 51st day. 193 | 194 | ![Predict the 51st day](https://jinglescode.github.io/assets/img/posts/time-series-06.jpg) 195 | 196 | ## Why isn't my Model Performing? 197 | 198 | **The model has never seen similar data in the past**. In March 2020, where the market dipped and recovered within a month or two, this has never happened in history. The model is likely to fail to predict drastic changes in stock prices during those periods. 199 | 200 | **Price data is not scaled**. LSTMs are intrinsically sensitive to the scale of the input data. Thus, it is crucial to normalize the data. Standard min-max normalization has been included in the script, but if your model isn't performing, this is one area you can dig deeper. 201 | 202 | **We can add more features**. In a general sense, more features tend to make the model perform better. We can include trading indicators such as Moving average convergence divergence (MACD), Relative strength index (RSI), or Bollinger bands. 203 | 204 | **Add even more features**. Another amazing API that [Alpha Vantage API](https://www.alphavantage.co/documentation/#fundamentals) provides is Fundamental Data. This means that you can also include annual and quarterly income statements and cash flows for the company of interest. Who knows, those features might be useful. 205 | 206 | There could have many other reasons why the model fails to learn and predict. This is the challenge of machine learning; it is both an art and science to build good performing models. 207 | 208 | ## Conclusion 209 | 210 | There are many ways to do time series prediction other than using a simple moving average. Possible future work is to implement this with more data from various sources. 211 | 212 | With TensorFlow.js, machine learning on a web browser is possible, and it is actually pretty cool. 213 | 214 | [Explore the demo on Github](https://jinglescode.github.io/time-series-forecasting-tensorflowjs), this experiment is 100% educational and by no means a trading prediction tool. 215 | 216 | --- 217 | 218 | # Updates 219 | 220 | - **May 2021**: Fixed data the normalize function, more robust for different dataset. 221 | - **Dec 2020**: Use adjusted close price instead, to remove any artificial price turbulences due to stock splits and dividend payout events 222 | 223 | --- 224 | 225 | # Contribute 226 | 227 | This project is by no means the final version. As discussed above on [why model isn't performing](#why-isnt-my-model-performing), there are many ways to improve the model performance. You can contribute! All contributions are welcome whether to improve to build a robust model or fix up the user interface. 228 | 229 | # License 230 | 231 | A permissive license whose main conditions require preservation of copyright and license notices. Contributors provide an express grant of patent rights. Licensed works, modifications, and larger works may be distributed under different terms and without source code. 232 | 233 | [Apache License 2.0](https://github.com/jinglescode/time-series-forecasting-tensorflowjs/blob/master/LICENSE) 234 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Time Series Forecasting with TensorFlow.js - Hong Jing (Jingles) 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 43 | 48 | 49 |
50 |
51 |
52 |

Time Series Forecasting with TensorFlow.js

53 |
Pull stock prices from online API and perform predictions using Recurrent Neural Network and Long Short-Term Memory (LSTM) with TensorFlow.js framework.
54 |
55 |
56 | Time Series Forecasting with TensorFlow.js 57 |
58 |
59 |

60 | 61 | Machine learning is becoming increasingly popular these days and a growing number of the world’s population see it is as a magic crystal ball: predicting when and what will happen in the future. This experiment uses artificial neural networks to reveal stock market trends and demonstrates the ability of time series forecasting to predict future stock prices based on past historical data. 62 |

63 |

64 | 65 | Disclaimer: As stock markets fluctuation are dynamic and unpredictable owing to multiple factors, this experiment is 100% educational and by no means a trading prediction tool. 66 |

67 |

68 | 69 | There are 4 parts to this experiment: 70 |

  • get historical stocks prices data
  • 71 |
  • prepare training data for our neural network model
  • 72 |
  • training the neural network
  • 73 |
  • do some prediction
  • 74 |

    75 |

    76 | Also, do check out this repo for the PyTorch version where we dig deeper on the model and the data processing steps. 77 |

    78 | 84 |
    85 |
    86 | 87 |
    88 |
    89 | Get Stocks Data 90 |

    91 | 92 | Before we can train the neural network and make any predictions, we will first require data. The type of data we are looking for is time series: a sequence of numbers in chronological order. A good place to fetch these data is the Alpha Vantage Stock API. This API allows us to retrieve chronological data on specific company stocks prices from the last 20 years. You may also refer to this article. that explains adjusted stock prices, which is an important technical concept for working with historical market data. 93 |

    94 |

    95 | You can either pick daily adjusted or weekly adjusted, open/high/low/close/volume values, daily adjusted close values, and historical split/dividend events of the global equity specified, covering 20+ years of historical data. As suggested by desduvauchelle, using adjusted close price is more robust to stock split compared to using closing price. 96 |

    97 |

    98 | The API yields the following fields: 99 |

  • open price
  • 100 |
  • highest price of that day
  • 101 |
  • lowest price of that day
  • 102 |
  • closing price
  • 103 |
  • adjusted close price (this is used in this project)
  • 104 |
  • volume
  • 105 |

    106 |

    107 | To prepare training dataset for our neural network, we will be using adjusted close stocks price; which also means that we will be aiming to predict future closing price. 108 |

    109 | 110 | Try It 111 | 112 |

    113 | 114 | Use demo API key to fetch Microsoft Corporation prices or get your own API key for other stocks. 115 |

    116 | 117 |
    118 |
    119 |
    120 | 121 | 122 | Demo API key only allows 'MSFT' 123 |
    124 |
    125 |
    126 |
    127 | 128 | 129 | You can claim your API key from alphavantage.co 130 |
    131 |
    132 |
    133 |
    134 | 138 | 139 |
    140 |
    141 |
    142 | 143 | 154 | 155 |
    156 |
    157 | 158 | 171 | 172 |
    173 |
    174 | 175 | 176 |
    177 |
    178 | Simple Moving Average 179 |

    180 | 181 | For this experiment, we are using supervised learning, which means feeding data to the neural network and it learns by mapping input data to the output label. One way to prepare the training dataset is to extract Simple Moving Average from that time series data. 182 |

    183 |

    184 | Simple Moving Average (SMA) is a method to identify trends direction for a certain period of time, by looking at the average of all the values within that time window. The number of prices in a time window is selected experimentally. For example, let's assume the closing prices for past 5 days were 13, 15, 14, 16, 17, the SMA would be (13+15+14+16+17)/5 = 15. So the input for our training dataset is the set of prices within a single time window, and label is the computed moving average of those prices. 185 |

    186 | 187 | Try It 188 | 189 |
    190 |
    191 |

    But first, fetch stocks data from the previous step.

    192 |
    193 |
    194 | 195 | 214 | 215 | 225 | 236 | 237 |
    238 |
    239 | 240 | 241 |
    242 |
    243 | Train Neural Network 244 |

    245 | 246 | Now that you have the training data, it is time to create a model for time series prediction, to achieve this we will use TensorFlow.js framework. 247 |

    248 |

    249 | Sequential model is selected which simply connects each layer and pass the data from input to the output during the training process. In order for the model to learn time series data which are sequential, recurrent neural network (RNN) layer layer is created and a number of LSTM cells are added to the RNN. 250 |

    251 |

    252 | The model will be trained using Adam (read more), a popular optimisation algorithm for machine learning. Root-means-squared error which determine the difference between predicted values and the actual values, so model is able to learn by minimising the error during the training process. 253 |

    254 |

    255 | 256 | These are the hyperparameters (parameters used in the training process) available for tweaking: 257 |

  • Training Dataset Size (%): the amount of data used for training, and remaining data will be used for prediction
  • 258 |
  • Epochs: number of times the dataset is used to train the model (learn more)
  • 259 |
  • Learning Rate: amount of change in the weights during training in each step (learn more)
  • 260 |
  • Hidden LSTM Layers: to increase the model complexity to learn in higher dimensional space (learn more)
  • 261 |

    262 | 263 | Try It 264 |

    265 | 266 | You may tweak the hyperparameters and then hit the Begin Training Model button to train the model. 267 |

    268 |
    269 |
    270 |

    Need training data? Explore the previous section to prepare training data.

    271 |
    272 |
    273 | 274 | 315 | 316 | 339 | 340 |
    341 |
    342 | 343 | 344 |
    345 |
    346 | Validation 347 |

    348 | 349 | Now that you have trained your model, it is time to use the model.predict function from TFJS to predicting future values. We have split the data into 2 sets, a subset of the data is training and the rest is the validation set. The training set has been used for training the model, thus will be using the validation set to validate the model. Since the model has not seen the data in the validation set before, it will be good if the model is able to predict values that are close to the exact values. 350 |

    351 | Try It 352 |

    So let us use the remaining data for prediction which allow us to see how closely our predicted values are compared to the actual values.

    353 |

    But if the model did not predict values that map closely to its true values, check the training loss graph. Generally, this model should converge with the loss to be less than 1. You can increase the number of epochs, or tweak the other learning hyperparameters.

    354 | 355 |
    356 |
    357 |

    Don’t have a model to perform prediction? Train your model.

    358 |
    359 |
    360 | 361 | 373 | 383 | 384 |
    385 |
    386 | 387 | 388 |
    389 |
    390 | Make Prediction 391 |

    392 | 393 | Finally, the model has been validated and the predicted values map closely to its true values, we shall use it to predict the future. We will apply the same model.predict function and use the last {{input_windowsize}} data points as the input, because that is our window size. This means that, if our training data is increment daily, we will use the past {{input_windowsize}} days as input, to predict the next day. 394 |

    395 | 396 | Try It 397 |
    398 |
    399 |

    Don’t have a model to perform prediction? Train your model.

    400 |
    401 |
    402 | 414 | 424 | 425 |
    426 |
    427 | 428 | 429 | 430 |
    431 |
    432 | Conclusion 433 |

    434 | Why isn’t my Model Performing?
    435 | The model has never seen similar data in the past. In March 2020, where the market dipped and recovered within a month or two, this has never happened in history. The model is likely to fail to predict drastic changes in stock prices during those periods.
    436 | We can add more features. In a general sense, more features tend to make the model perform better. We can include trading indicators such as Moving average convergence divergence (MACD), Relative strength index (RSI), or Bollinger bands.
    437 | Add even more features. One amazing thing that Alpha Vantage API provides is Fundamental Data. This means that you can also include annual and quarterly income statements and cash flows for the company of interest. Who knows, those features might be useful.
    438 | There could have many other reasons why the model fails to learn and predict. This is the challenge of machine learning; it is both an art and science to build good performing models. 439 |

    440 | 441 |

    442 | There are many ways to do time series prediction other than using a simple moving average. Do check out this repo for the PyTorch version where we attempt to predict the stock price instead of the SMA. Other possible future work is to implement this with more data from various sources.
    443 | With TensorFlow.js, machine learning on a web browser is possible, and it is actually pretty cool.
    444 | Explore the demo on Github, this experiment is 100% educational and by no means a trading prediction tool. 445 |

    446 |
    447 |
    448 | 449 | 450 | 451 |
    452 | 461 | 470 | 479 |
    480 | 481 |
    482 | 483 | 484 | 485 | 486 | 487 | 488 | 489 | 490 | 491 | 498 | 499 | 500 | 501 | -------------------------------------------------------------------------------- /model.js: -------------------------------------------------------------------------------- 1 | async function trainModel(X, Y, window_size, n_epochs, learning_rate, n_layers, callback){ 2 | 3 | const batch_size = 32; 4 | 5 | // input dense layer 6 | const input_layer_shape = window_size; 7 | const input_layer_neurons = 64; 8 | 9 | // LSTM 10 | const rnn_input_layer_features = 16; 11 | const rnn_input_layer_timesteps = input_layer_neurons / rnn_input_layer_features; 12 | const rnn_input_shape = [rnn_input_layer_features, rnn_input_layer_timesteps]; // the shape have to match input layer's shape 13 | const rnn_output_neurons = 16; // number of neurons per LSTM's cell 14 | 15 | // output dense layer 16 | const output_layer_shape = rnn_output_neurons; // dense layer input size is same as LSTM cell 17 | const output_layer_neurons = 1; // return 1 value 18 | 19 | // ## old method 20 | // const xs = tf.tensor2d(X, [X.length, X[0].length])//.div(tf.scalar(10)); 21 | // const ys = tf.tensor2d(Y, [Y.length, 1]).reshape([Y.length, 1])//.div(tf.scalar(10)); 22 | 23 | // ## new: load data into tensor and normalize data 24 | 25 | const inputTensor = tf.tensor2d(X, [X.length, X[0].length]) 26 | const labelTensor = tf.tensor2d(Y, [Y.length, 1]).reshape([Y.length, 1]) 27 | 28 | const [xs, inputMax, inputMin] = normalizeTensorFit(inputTensor) 29 | const [ys, labelMax, labelMin] = normalizeTensorFit(labelTensor) 30 | 31 | // ## define model 32 | 33 | const model = tf.sequential(); 34 | 35 | model.add(tf.layers.dense({units: input_layer_neurons, inputShape: [input_layer_shape]})); 36 | model.add(tf.layers.reshape({targetShape: rnn_input_shape})); 37 | 38 | let lstm_cells = []; 39 | for (let index = 0; index < n_layers; index++) { 40 | lstm_cells.push(tf.layers.lstmCell({units: rnn_output_neurons})); 41 | } 42 | 43 | model.add(tf.layers.rnn({ 44 | cell: lstm_cells, 45 | inputShape: rnn_input_shape, 46 | returnSequences: false 47 | })); 48 | 49 | model.add(tf.layers.dense({units: output_layer_neurons, inputShape: [output_layer_shape]})); 50 | 51 | model.compile({ 52 | optimizer: tf.train.adam(learning_rate), 53 | loss: 'meanSquaredError' 54 | }); 55 | 56 | // ## fit model 57 | 58 | const hist = await model.fit(xs, ys, 59 | { batchSize: batch_size, epochs: n_epochs, callbacks: { 60 | onEpochEnd: async (epoch, log) => { 61 | callback(epoch, log); 62 | } 63 | } 64 | }); 65 | 66 | // return { model: model, stats: hist }; 67 | return { model: model, stats: hist, normalize: {inputMax:inputMax, inputMin:inputMin, labelMax:labelMax, labelMin:labelMin} }; 68 | } 69 | 70 | function makePredictions(X, model, dict_normalize) 71 | { 72 | // const predictedResults = model.predict(tf.tensor2d(X, [X.length, X[0].length]).div(tf.scalar(10))).mul(10); // old method 73 | 74 | X = tf.tensor2d(X, [X.length, X[0].length]); 75 | const normalizedInput = normalizeTensor(X, dict_normalize["inputMax"], dict_normalize["inputMin"]); 76 | const model_out = model.predict(normalizedInput); 77 | const predictedResults = unNormalizeTensor(model_out, dict_normalize["labelMax"], dict_normalize["labelMin"]); 78 | 79 | return Array.from(predictedResults.dataSync()); 80 | } 81 | 82 | function normalizeTensorFit(tensor) { 83 | const maxval = tensor.max(); 84 | const minval = tensor.min(); 85 | const normalizedTensor = normalizeTensor(tensor, maxval, minval); 86 | return [normalizedTensor, maxval, minval]; 87 | } 88 | 89 | function normalizeTensor(tensor, maxval, minval) { 90 | const normalizedTensor = tensor.sub(minval).div(maxval.sub(minval)); 91 | return normalizedTensor; 92 | } 93 | 94 | function unNormalizeTensor(tensor, maxval, minval) { 95 | const unNormTensor = tensor.mul(maxval.sub(minval)).add(minval); 96 | return unNormTensor; 97 | } 98 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "time-series-forecasting-tensorflowjs", 3 | "version": "1.0.0", 4 | "description": "Pull stock prices from online API and perform predictions using Recurrent Neural Network & Long Short Term Memory (LSTM) with TensorFlow.js framework", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "push": "git push https://github.com/jinglescode/time-series-forecasting-tensorflowjs.git master" 9 | }, 10 | "repository": { 11 | "type": "git", 12 | "url": "git+https://github.com/jinglescode/time-series-forecasting-tensorflowjs.git" 13 | }, 14 | "keywords": [ 15 | "machine-learning", 16 | "tensorflowjs", 17 | "javascript" 18 | ], 19 | "author": "Khok Hong Jing (Jingles)", 20 | "license": "ISC", 21 | "bugs": { 22 | "url": "https://github.com/jinglescode/time-series-forecasting-tensorflowjs/issues" 23 | }, 24 | "homepage": "https://jinglescode.github.io/time-series-forecasting-tensorflowjs" 25 | } 26 | --------------------------------------------------------------------------------