.. SoundPy documentation master file, created by
   sphinx-quickstart on Mon Jun 15 11:57:18 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SoundPy v0.1.0a3
================  

Welcome to the docs!
--------------------

   
SoundPy is a research based Python package_ for exploring and experimenting with sound and deep learning. NOTE: SoundPy is in alpha stage of development; please forgive any bugs that pop up, and also feel free/encouraged to open an issue_. 

Those who might find this useful: 

* speech and sound enthusiasts
* digital signal processing / mathematics / physics / acoustics enthusiasts
* deep learning enthusiasts
* researchers
* linguists
* psycholinguists

The main goal of SoundPy is to provide the code and functionality with more context via visualization, research, and mathematics. Most of the resources used to build the functionality stems from publicly available research and datasets.

As it covers quite a large range, from audio file conversion to implementation of trained neural networks, the purpose of SoundPy is not to be the perfect implementation of all functions (although that is also a goal :P ), but rather a peak into how they *can* be implemented, hopefully offering people a foundation for trying out different ways of implementation (feature extraction, building neural networks, etc.).

This project is still in the beginning stages and has a lot of room for growth, especially with contributors having a background / knowlege in data science, computer science, machine and deep learning, physics, acoustics, or dsp. Contributors from other backgrounds are also welcome! If you'd like SoundPy to do something it doesn't, try making it or create an issue.

.. _PyPI: https://pypi.org/project/soundpy/

.. _package: https://github.com/a-n-rose/Python-Sound-Tool/tree/development

.. _issue: https://github.com/a-n-rose/Python-Sound-Tool/issues

.. toctree:: 
   :maxdepth: 2
   
   example_cases.rst
   readme.rst

   
.. toctree:: 
   :maxdepth: 1
   
   changelog.rst
   
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

:Author:
    Aislyn Rose 
    
    rose.aislyn.noelle@gmail.com
    
    webpage_
    
    github_
    
.. _webpage: https://a-n-rose.github.io/
 
.. _github : https://github.com/a-n-rose