Skip to content

Commit 9b8a19b

Browse files
committed
fix doc
1 parent 7e2e007 commit 9b8a19b

3 files changed

Lines changed: 5 additions & 3 deletions

File tree

docs/source/core_api/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Core API
33
=================
44

5+
Introduction
6+
=============
7+
58
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
69

710
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.
@@ -16,7 +19,6 @@ The following diagram shows and example of a pipe.
1619
.. image:: ../images/TimeSide_pipe.svg
1720
:width: 800 px
1821

19-
2022
Classes
2123
========
2224

docs/source/development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Development
33
===========
44

5-
First, setup the composition environment at the root of the project:
5+
First, setup the composition environment at the root of the project::
66

77
echo "COMPOSE_FILE=docker-compose.yml:env/debug.yml" > .env
88

docs/source/production.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Production
33
===========
44

5-
First, setup the composition environment at the root of the project:
5+
First, setup the composition environment at the root of the project::
66

77
echo "COMPOSE_FILE=docker-compose.yml:env/prod.yml" > .env
88

0 commit comments

Comments
 (0)