Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
abdullah-al-masud committed Sep 20, 2021
1 parent e40a134 commit 312fbac
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ MIT open source License has been issued for this library.

Examples
---------
You can find easy examples on how to use the functions and classes from this library `here <https://github.com/abdullah-al-masud/msdlib/tree/release-v1/examples>`_.
You can find easy examples on how to use the functions and classes from this library `here <https://github.com/abdullah-al-masud/msdlib/tree/master/examples>`_.

Necessary data is also provided in this directory.


Expand Down Expand Up @@ -111,7 +112,7 @@ This module provides functionalities for easier implementation of Pytorch Deep L
- Producing automated results with beautiful tables having precision, recall, f1_score, accuracy and specificity in classification problems
- Producing automated graphs of true-vs-prediction and result preparation for regression model

Examples are available for regression, binary and multi-class classification models `here <https://github.com/abdullah-al-masud/msdlib/tree/release-v1/examples>`_.
Examples are available for regression, binary and multi-class classification models `here <https://github.com/abdullah-al-masud/msdlib/tree/master/examples>`_.


---------------
Expand All @@ -131,7 +132,7 @@ We have three options here to split data set-
- cross_validation_split
- sequence_split (specially necessary for RNN/LSTM)

Examples are available `here <https://github.com/abdullah-al-masud/msdlib/tree/release-v1/examples>`_.
Examples are available `here <https://github.com/abdullah-al-masud/msdlib/tree/master/examples>`_.


-----------------
Expand All @@ -151,6 +152,7 @@ It can show the results using bar plot and can handle classification and regress
class_result:
-------------
This function calculates classification model evaluation parameters like precision, recall, accuracy, f1 score, specificity etc. and also able to show confusion matrix as a pandas dataframe.
Example can be found `here <https://github.com/abdullah-al-masud/msdlib/tree/master/examples/class_result_example.py>`_.


-------------
Expand All @@ -171,6 +173,7 @@ data_gridplot:
.. image:: ../examples/data_grid_plot_example/Grid_plot_for_Iris_dataset.jpg

Its a function for scatter plots between every pair of features along with distributions (similar to matrix_plot in pandas). But it enables you to save the image, change figure_size, titles etc and also has one special feature for clusters in the data if any.
Example can be found `here <https://github.com/abdullah-al-masud/msdlib/tree/master/examples/data_grid_plot_example.py>`_.


-----------------
Expand All @@ -179,7 +182,8 @@ plot_time_series:

.. image:: ../examples/plot_time_series_example/Combined_Time_Series_Plot.jpg

This is one of the the most useful functions in this library. It helps to plot time series data with a lot of flexibility. It helps to plot time series data with a lot of flexibility. Please check out the example scripts for illustrations and guidance to use it.
This is a function and the most useful function for me from all my library functions and classes. It helps to plot time series data with a lot of flexibility. Please check out the example scripts for illustrations and guidance to use it.
Example can be found `here <https://github.com/abdullah-al-masud/msdlib/tree/master/examples/plot_time_series_example.py>`_.


-------------
Expand All @@ -205,6 +209,7 @@ Filters:
.. image:: ../examples/filters_and_spectrogram_example/Spectrogram_of_filtered_stereo_1.jpg

This is a class defined for applying low pass, high pass, band pass and band stop filters. It also enables us to visualize frequency domain of the signal, designed filter and also let us visualize the filtered signal if we apply a filter on the signal.
Example can be found `here <https://github.com/abdullah-al-masud/msdlib/tree/master/examples/filters_and_spectrogram_example.py>`_.


----------------
Expand Down

0 comments on commit 312fbac

Please sign in to comment.