actions: add Documentation workflow

This commit is contained in:
Hervé Bredin committed 2019-12-18 15:52:07 +01:00
1 parent 1baf1073e5
commit b89772210d
6 files changed
+161 -15

No files matched your search

+38
View File
@@ -0,0 +1,38 @@
name: Documentation
on:
push:
branches:
- master
jobs:
build-and-deploy:
runs-on: ubuntu-latest
strategy:
max-parallel: 4
matrix:
python-version: [3.7]
steps:
- uses: actions/checkout@v1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: Install
run: |
python -m pip install --upgrade pip
pip install .
pip install -r doc/requirements.txt
- name: Build documentation
run: |
make --directory=doc html
touch ./doc/build/html/.nojekyll
- name: Deploy
env:
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
PUBLISH_BRANCH: gh-pages
PUBLISH_DIR: ./doc/build/html
SCRIPT_MODE: true
run: |
wget https://raw.githubusercontent.com/peaceiris/actions-gh-pages/v2/entrypoint.sh
bash ./entrypoint.sh
+1 -1
View File
@@ -17,4 +17,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+36
View File
@@ -0,0 +1,36 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=pyannoteaudio
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd
+3
View File
@@ -0,0 +1,3 @@
Sphinx==2.2.2
ipython==7.10.1
sphinx_rtd_theme==0.4.3
+62
View File
@@ -0,0 +1,62 @@
#########
Changelog
#########
Version 2.x (WIP)
~~~~~~~~~~~~~~~~~
- BREAKING: switch to new pyannote.pipeline package
- BREAKING: add unified FeatureExtraction base class
- feat: add support for on-the-fly data augmentation
- setup: switch to librosa 0.6
Version 1.0.1 (2018--07-19)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- fix: fix regression in Precomputed.__call__ (#110, #105)
Version 1.0 (2018-07-03)
~~~~~~~~~~~~~~~~~~~~~~~~
- chore: switch from keras to pytorch (with tensorboard support)
- improve: faster & better traning (`AutoLR`, advanced learning rate schedulers, improved batch generators)
- feat: add tunable speaker diarization pipeline (with its own tutorial)
- chore: drop support for Python 2 (use Python 3.6 or later)
Version 0.3.1 (2017-07-06)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- feat: add python 3 support
- chore: rewrite neural speaker embedding using autograd
- feat: add new embedding architectures
- feat: add new embedding losses
- chore: switch to Keras 2
- doc: add tutorial for (MFCC) feature extraction
- doc: add tutorial for (LSTM-based) speech activity detection
- doc: add tutorial for (LSTM-based) speaker change detection
- doc: add tutorial for (TristouNet) neural speaker embedding
Version 0.2.1 (2017-03-28)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- feat: add LSTM-based speech activity detection
- feat: add LSTM-based speaker change detection
- improve: refactor LSTM-based speaker embedding
- feat: add librosa basic support
- feat: add SMORMS3 optimizer
Version 0.1.4 (2016-09-26)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- feat: add 'covariance_type' option to BIC segmentation
Version 0.1.3 (2016-09-23)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- chore: rename sequence generator in preparation of the release of
TristouNet reproducible research package.
Version 0.1.2 (2016-09-22)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- first public version
+21 -14
View File
@@ -1,19 +1,26 @@
.. pyannote.audio documentation master file, created by
sphinx-quickstart on Sat Oct 26 15:37:15 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pyannote.audio's documentation!
==========================================
##############
pyannote.audio
##############
`pyannote.audio` is an open-source Python library that provides neural building blocks for speaker diarization.
Installation
============
::
# create a conda environment with Python 3.6 or later
$ conda create --name pyannote python=3.6
$ source activate pyannote
# install pytorch following official instructions from https://pytorch.org/
$ pip install pyannote.audio
.. automodule:: pyannote.audio.train.task
:members:
API documentation
=================
.. toctree::
:maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
changelog