Skip to content

Commit aba535d

Browse files
committed
- Edited README.md
1 parent bd0b7c6 commit aba535d

File tree

2 files changed

+52
-2
lines changed

2 files changed

+52
-2
lines changed

README.md

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
1-
# Neural
2-
Library for working with neural networks
1+
<img src="icon.png" alt="icon" width="200"/>
2+
3+
# Neural
4+
###### ver 1.0.0
5+
6+
---
7+
8+
## Overview
9+
10+
**Neural** is an open source library designed to easily work with neural networks in the language
11+
**C++** programming. It provides a simple and clear interface that allows both novices and experienced
12+
it is easy for developers to create and train neural networks.
13+
14+
Thanks to the open source code, any developer can study the source code of the library, as well as contribute their own
15+
changes to improve its functionality or fix bugs. This makes it possible to make the library more
16+
efficient and easy to work with.
17+
18+
What's more, **Neural** can also be used to conduct research in the field of neural networks. Thanks to simplicity
19+
use and flexibility of the library, developers can quickly create different architectures of neural networks and
20+
check their effectiveness in solving various problems.
21+
22+
## Already present adn plans
23+
24+
1. [x] Multilayer Perceptron
25+
2. [x] **Four** activation functions
26+
3. [ ] Multithreading
27+
4. [ ] GPU multithreading
28+
5. [ ] Documentation
29+
6. [ ] Cross-platform
30+
7. [ ] More models
31+
32+
## Quick start
33+
34+
1. Install [**CMake**][5]
35+
2. Create [**CMake**][5] project
36+
3. Add `set(CMAKE_PREFIX_PATH path/to/NeuralConfig.cmake)`
37+
4. Add `include_directories(path/to/include)`
38+
5. Add `find_package(Neural REQUIRED)`
39+
6. Congratulations!
40+
41+
If you're having trouble, you can always refer to examples.
42+
---
43+
44+
#### Contacts
45+
46+
[VK][1], [Telegramm][2], [Discord][3]
47+
48+
[1]: https://vk.com/pavel.cmake
49+
[2]: https://t.me/pavel_cpp
50+
[3]: @pavel.cpp
51+
[4]: https://cybersoft.ru/razrabotka/redaktory/208-qt.html
52+
[5]: https://cmake.org/

icon.png

77.5 KB
Loading

0 commit comments

Comments
 (0)