use - for bullets

Author: yomguy

docs/source/core_api/index.rst

@@ -4,7 +4,7 @@ TimeSide core API
 
 TimeSide is first a python framework enabling low and high level audio analysis, imaging, transcoding, streaming and labelling. Its high-level API is designed to enable complex processing on very large datasets of any audio or video assets with a plug-in architecture, a secure scalable backend and an extensible dynamic web frontend. Some usecases: scaled audio computing (filtering, machine learning, etc), web audio visualization, audio process prototyping, realtime and on-demand transcoding and streaming over the web, automatic segmentation and labelling synchronized with audio events
 
-Because there are a lot of tools available in the Python ecosystem dedicated to music information retrieval, machine learning and data analysis, we have decided to embed all main ones: Aubio\cite{aubio}, Yaafe\cite{yaafe_ISMIR2010}, Essentia\cite{essentia}, VAMP\cite{vamp-plugins}, librosa\cite{librosa}, GStreamer, TensorFlow, Torch, PyTorch, scikit-learn, Jupyter, Pandas and Pytables. They are used to develop native TimeSide plugins though its simple processing API.
+Because there are a lot of tools available in the Python ecosystem dedicated to music information retrieval, machine learning and data analysis, we have decided to embed all main ones: Aubio, Yaafe, Essentia, VAMP, librosa, GStreamer, TensorFlow, Torch, PyTorch, scikit-learn, Jupyter, Pandas and Pytables. They are used to develop native TimeSide plugins though its simple processing API.
 
 
 .. toctree::

docs/source/intro.rst

@@ -5,39 +5,46 @@ TimeSide : scalable audio processing framework and server written in Python
 TimeSide is a python framework enabling low and high level audio analysis, imaging, transcoding, streaming and labelling. Its high-level API is designed to enable complex processing on very large datasets of any audio or video assets with a plug-in architecture, a secure scalable backend and an extensible dynamic web frontend.
 
 
+Introduction
+=============
+
+As the number of online audio applications and datasets increase, it becomes crucial for researchers and engineers to be able to prototype and test their own algorithms as fast as possible on various platforms and usecases like computational musicology and streaming services. On the other side, content providers and producers need to enhance user experiences on their platforms with more metadata based on cultural history but also audio feature analyses. Growing those metadata synchronously with the music published on the internet implies that the analysis and storage systems can be easily updated, scaled and deployed.
+
+TimeSide has been developed in this sense to propose an online audio processing service. It provides a REST API as well as a javascript SDK so that web developers can easily embed the service into their own applications without requesting to much local resources on the user side to compute audio features.
+
 Use cases
 ==========
 
-* Scaled audio computing (filtering, machine learning, etc)
-* Web audio visualization
-* Audio process prototyping
-* Realtime and on-demand transcoding and streaming over the web
-* Automatic segmentation and labelling synchronized with audio events
+- Scaled audio computing (filtering, machine learning, etc)
+- Web audio visualization
+- Audio process prototyping
+- Realtime and on-demand transcoding and streaming over the web
+- Automatic segmentation and labelling synchronized with audio events
 
 
 Goals
 =====
 
-* **Do** asynchronous and fast audio processing with Python,
-* **Decode** audio frames from **any** audio or video media format into numpy arrays,
-* **Analyze** audio content with some state-of-the-art audio feature extraction libraries like Aubio, Yaafe and VAMP as well as some pure python processors
-* **Visualize** sounds with various fancy waveforms, spectrograms and other cool graphers,
-* **Transcode** audio data in various media formats and stream them through web apps,
-* **Serialize** feature analysis data through various portable formats,
-* **Provide** audio sources from plateform like YouTube or Deezer  
-* **Deliver** analysis and transcode on provided or uploaded tracks over the web through a REST API
-* **Playback** and **interact** **on demand** through a smart high-level HTML5 extensible player,
-* **Index**, **tag** and **annotate** audio archives with semantic metadata (see `Telemeta <http://telemeta.org>`__ which embed TimeSide).
-* **Deploy** and **scale** your own audio processing engine through any infrastructure
+- **Do*- asynchronous and fast audio processing with Python,
+- **Decode*- audio frames from **any*- audio or video media format into numpy arrays,
+- **Analyze*- audio content with some state-of-the-art audio feature extraction libraries like Aubio, Yaafe and VAMP as well as some pure python processors
+- **Visualize*- sounds with various fancy waveforms, spectrograms and other cool graphers,
+- **Transcode*- audio data in various media formats and stream them through web apps,
+- **Serialize*- feature analysis data through various portable formats,
+- **Provide*- audio sources from plateform like YouTube or Deezer
+- **Deliver*- analysis and transcode on provided or uploaded tracks over the web through a REST API
+- **Playback*- and **interact*- **on demand*- through a smart high-level HTML5 extensible player,
+- **Index**, **tag*- and **annotate*- audio archives with semantic metadata (see `Telemeta <http://telemeta.org>`__ which embed TimeSide).
+- **Deploy*- and **scale*- your own audio processing engine through any infrastructure
 
 
 Funding and support
 ===================
 
 To fund the project and continue our fast development process, we need your explicit support. So if you use TimeSide in production or even in a development or experimental setup, please let us know by:
 
-* staring or forking the project on `GitHub <https://github.com/Parisson/TimeSide>`_
-* tweeting something to `@parisson_studio <https://twitter.com/parisson_studio>`_ or `@telemeta <https://twitter.com/telemeta>`_
-* drop us an email on <support@parisson.com> or <pow@ircam.fr>
+- staring or forking the project on `GitHub <https://github.com/Parisson/TimeSide>`_
+- tweeting something to `@parisson_studio <https://twitter.com/parisson_studio>`_ or `@telemeta <https://twitter.com/telemeta>`_
+- drop us an email on <support@parisson.com> or <pow@ircam.fr>
 
 Thanks for your help!

docs/source/ui.rst

@@ -107,24 +107,24 @@ Find some preset examples in examples/presets/
 Web player
 -----------
 
-TimeSide comes with a smart and pure **HTML5** audio player.
+TimeSide comes with a smart and pure **HTML5*- audio player.
 
 Features:
 
-* embed it in any audio web application
-* stream, playback and download various audio formats on the fly
-* synchronize sound with text, bitmap and vectorial events
-* seek through various semantic, analytic and time synced data
-* fully skinnable with CSS style
+- embed it in any audio web application
+- stream, playback and download various audio formats on the fly
+- synchronize sound with text, bitmap and vectorial events
+- seek through various semantic, analytic and time synced data
+- fully skinnable with CSS style
 
 .. image:: https://raw.githubusercontent.com/Parisson/TimeSide/dev/docs/images/timeside_player_01.png
   :alt: TimeSide player
 
 Examples of the player embeded in the Telemeta open web audio CMS:
 
-* http://parisson.telemeta.org/archives/items/PRS_07_01_03/
-* http://archives.crem-cnrs.fr/items/CNRSMH_I_1956_002_001_01/
+- http://parisson.telemeta.org/archives/items/PRS_07_01_03/
+- http://archives.crem-cnrs.fr/items/CNRSMH_I_1956_002_001_01/
 
 Development documentation:
 
-* https://github.com/Parisson/TimeSide/wiki/Ui-Guide
+- https://github.com/Parisson/TimeSide/wiki/Ui-Guide