From a5b93dc0629ebbe2289532f4ce292a296dee0d8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=2E=20Fran=C3=A7ois?= Date: Thu, 7 Jun 2018 14:19:06 +0200 Subject: [PATCH] partial update --- .gitignore | 2 ++ README.md | 2 +- docs/README.rst | 32 -------------------------------- docs/sphinx/conf.py | 32 +++++++++++++++++--------------- docs/sphinx/index.rst | 2 +- neural_filters/__init__.py | 1 - setup.py | 12 ++++++------ 7 files changed, 27 insertions(+), 56 deletions(-) diff --git a/.gitignore b/.gitignore index 23678da..bd21542 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +.idea/ + *~ docs/html docs/sphinx/_build diff --git a/README.md b/README.md index bd1cba4..9d97dc7 100644 --- a/README.md +++ b/README.md @@ -1 +1 @@ -neural_filters +neural_filters is a PyTorch toolbox implementing linear IIR filters as recurrent neural units diff --git a/docs/README.rst b/docs/README.rst index 4133020..4bbabee 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -2,38 +2,6 @@ Welcome to Neural Filters’s documentation! ****************************************** -NeuralFilter1P -============== - -This module implements a trainable all-pole first order filter using -pyTorch - -Copyright (c) 2018 Idiap Research Institute, http://www.idiap.ch/ -Written by Francois Marelli - -This file is part of neural_filters. - -neural_filters is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License version 3 as -published by the Free Software Foundation. - -neural_filters is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with neural_filters. If not, see . - -class NeuralFilter1P.NeuralFilter1P(input_size, hidden_size) - - A trainable first-order all-pole filter \frac{K}{1 - P z^{-1}} - - * **input_size** (int) - the size of the input vector - - * **hidden_size** (int) - the size of the output vector - - Indices and tables ****************** diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 1614b9b..fbaefa0 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -16,10 +16,13 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # + import os import sys -sys.path.insert(0, os.path.abspath(os.path.join('..','..','neural_filters'))) -import NeuralFilter1P + +sys.path.insert(0, os.path.abspath(os.path.join('..', '..', 'neural_filters'))) + +import neural_filters # -- General configuration ------------------------------------------------ @@ -119,7 +122,6 @@ pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False - # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -244,21 +246,21 @@ htmlhelp_basename = 'NeuralFiltersdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 94a4043..9727f42 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -10,7 +10,7 @@ Welcome to Neural Filters's documentation! :maxdepth: 2 :caption: Contents: -.. automodule:: NeuralFilter1P +.. automodule:: neural_filters :members: Indices and tables diff --git a/neural_filters/__init__.py b/neural_filters/__init__.py index 96d76ee..b410f32 100644 --- a/neural_filters/__init__.py +++ b/neural_filters/__init__.py @@ -25,7 +25,6 @@ def atanh(x): return numpy.arctanh(x) -from .log_loss import * from .neural_filter import * from .neural_filter_2CC import * from .neural_filter_2CD import * diff --git a/setup.py b/setup.py index 8174237..4f2e3b9 100644 --- a/setup.py +++ b/setup.py @@ -2,18 +2,18 @@ from setuptools import setup setup( name='neural_filters', - version='0.1', + version='1.0', description='Linear filters for neural networks in pyTorch', author='Idiap research institute - Francois Marelli', author_email='francois.marelli@idiap.ch', classifiers=[ - # 3 - Alpha - # 4 - Beta - # 5 - Production/Stable - 'Development Status :: 3 - Alpha', + 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: GNU GPL v3', 'Programming Language :: Python :: 3.6', ], - install_requires=['torch>=0.4.0'], + install_requires=[ + 'torch>=0.4.0', + 'numpy', + ], ) -- 2.21.0