Examples/readme update

README.md

@@ -1,4 +1,9 @@
+
 # TorchCNNBuilder
+<p align="center">
+
+<img src=".docs/media/logo_transparent_h.PNG" width="600">
+</p>
 
 <div id="badges">
     <a href="https://pytorch.org/">
@@ -21,6 +26,33 @@ The simplest way to install framework is using `pip`:
 pip install torchcnnbuilder
 ```
 
+
+### Usage
+
+To initialize simple model with encoder-decoder architecture call ```ForecasterBase``` class:
+```python
+from torchcnnbuilder.models import ForecasterBase
+
+model = ForecasterBase(input_size=[H, W],
+                       in_time_points=C_in,
+                       out_time_points=C_out,
+                       n_layers=5)
+```
+Where ```[H, W]``` - size of image in pixels, ```C_in``` - number of input channels, ```C_out``` - number of out_channels. 
+
+To operate separately with encoder and decoder parts they can be called from model:
+```python
+encoder = model.encoder
+decoder = model.decoder
+```
+
+### Examples
+
+Extensive usage scenarios can be found in [examples](examples) folder.
+
+Components calls and usage in folder [usage_examples](examples/usage_examples).
+
+
 ### Documentation 
 
 Check the documentation [here](https://chrislisbon.github.io/TorchCNNBuilder/torchcnnbuilder.html). 
@@ -44,6 +76,14 @@ doc: Build and run the doc locally.
 - [Surrogate Modelling for Sea Ice Concentration using Lightweight Neural Ensemble](https://arxiv.org/abs/2312.04330)
 - [Post about framework development on habr.com - in russian](https://habr.com/ru/companies/selectel/articles/818649/)
 
+
+### Contributing
+
+- To join the project feel free to [contact us](mailto:jul.borisova@itmo.ru);
+
+- [Issues](https://github.com/ChrisLisbon/TorchCNNBuilder/issues) and 
+[Pull Requests](https://github.com/ChrisLisbon/TorchCNNBuilder/pulls): submit bugs found or log feature requests.
+
 ### Acknowledgement
 
 The project is supported by [FASIE](https://fasie.ru/) - Foundation for Assistance to Small Innovative Enterprises.