Updated README file

fialhocoelho · Feb 14, 2020 · ee71359 · ee71359
1 parent a6a18e5
commit ee71359
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 56 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,16 @@
 # Track Particle
-This project is the first version of track particles and is part of SPRACE center. 
+This project is the first version of Track Particles problem and it is part of [SPRACE](https://sprace.org.br/) sponsored by [Serrapilheira](https://serrapilheira.org/). 
 
-# Run
-To run main-paralel.py file over a gpu machine or you can use test_1_lstm_paralel.ipynb notebook to run into Google Colab.
 
-# Accuracy of Algorithm
+
+## Run
+To run:
+1. Clone our repository
+2. Configure your conda envirotment 
+3. Run ` python main.py --config config.json `. It will create  a first model with LSTM architecture. If you don't have acces to a gpu, you could use the `test_1_lstm_paralel.ipynb` file to run into Google Colab.
+
+## Accuracy of Algorithm
+We are using regressions metrics for each hit. Our accuracy is showed for forecas of 5 hit. 
 
 ```
 [Output] ---Regression Scores--- 
@@ -17,5 +23,5 @@ RMSE features: 	[0.15, 0.23, 0.09]
 R^2  features:	[0.97, 0.94, 0.99] 
 ```
 
-# Vizualization
+## Vizualization
 Open the plot_prediction.ipynb file to see the 5 hit predicted.
diff --git a/config-paralel.json b/config-paralel.json