Skip to content

Commit 3117d61

Browse files
Update README.md
1 parent c0b6dfb commit 3117d61

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
1+
<div align="center">
2+
<picture>
3+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/hamdivazim/pypredictor/raw/main/logo_dark.png">
4+
<img src="https://github.com/hamdivazim/pypredictor/raw/main/logo.png" alt="pypredictor logo">
5+
</picture>
6+
</div>
7+
18
# pypredictor
2-
A Python library that can predict the next values in a list.
9+
<p>
10+
<img src="https://img.shields.io/badge/Python-3.8 | 3.9 | 3.10 | 3.11 -blue.svg" alt="py versions">
11+
<img src="https://img.shields.io/badge/PyPi package-0.1.0-green.svg" alt="pypi version">
12+
<img src="https://img.shields.io/badge/License-Apache License 2.0-green.svg" alt="license">
13+
<img src="https://img.shields.io/badge/Libraries-tensorflow | numpy | seaborn | pandas-green.svg" alt="libs">
14+
<img src="https://img.shields.io/badge/tests-all passing-green.svg" alt="tests">
15+
</p>
16+
17+
The Python library that makes AI predictions simple.
18+
19+
## What can it do?
20+
pypredictor uses an RNN (Recurrent Neural Network) to predict the next n numbers in a sequence. As an example, using this code:
21+
```python
22+
pred = NumPredictor(500)
23+
print(pred.predict([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 5, 3))
24+
```
25+
pypredictor generated the following output, which is quite accurate:
26+
```
27+
[10.969043, 11.950292, 12.920968, 13.859894, 14.789316]
28+
```
29+
pypredictor also has the ability to generate a pandas DataFrame and a seaborn line graph, from an initial sequence/DataFrame which you provide.
30+
###
31+
Plus, there are examples in the `examples/` directory, so you can take a look for yourself :)
32+
33+
## How to install
34+
Install via pip:
35+
```
36+
$ pip install pypredictor
37+
```

0 commit comments

Comments
 (0)