Skip to content
Snippets Groups Projects
Commit 1db2096a authored by Dominique Benielli's avatar Dominique Benielli
Browse files

first commit

parents
No related branches found
No related tags found
No related merge requests found
Showing
with 915 additions and 0 deletions
# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so
*.a
*.mexmaci64
*.mexa64
# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip
# Logs and databases #
######################
*.log
*.sql
*.sqlite
# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
# Backup files #
################
*~
*.bkup
*.old
# Directories #
###############
build/
doc/_*
.svn/
.settings/
.ipynb_checkpoints/
# Eclipse files #
#################
.project
.pydevproject
# python codebytes files #
##########################
*.pyc
# Binaries #
############
bin/*
# Others #
##########
.coverage
.cache
skgilearn.egg-info/*
htmlcov/
doc/_build/
doc/_static/
doc/_template/
*.bat
*.pkl
MANIFEST
scikit_gilearn.egg-info/
scikit_splearn.egg-info/*
.idea/
.. -*- mode: rst -*-
History
-------
People
------
.. hlist::
* François Denis
* Rémi Eyraud
* Denis Arrivault
* Dominique Benielli
COPYING 0 → 100644
New BSD License
Copyright (c) DATE, The SCIKIT-SPLEARN developers.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
a. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
b. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
c. Neither the name of the scikit-splearn developers nor the names of
its contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
\ No newline at end of file
.. :changelog:
History
=======
1.0.0 (2016-06-30)
------------------
First version
1.0.1 (2016-10-07)
------------------
Bug setup correction
\ No newline at end of file
recursive-include doc *.rst *.py *.png *.bib
prune splearn/tests
include *.txt
include *.rst
include VERSION
exclude tests_results.txt
exclude requirements*
exclude copyright*
The **SCIKIT-SPLEARN** package is a Python tool of the
`Scikit-Spectral Learning (scikit-splearn)
<http://splearning.sourceforge.net/>`_, scikit-splearn is a toolbox in
python for spectral learning algorithms.
scikit-splearn is a sckit compatible SP2Learning toolbox.
scikit-splearn is a toolbox in python for spectral learning algorithms.
These algorithms aim at learning Weighted Automata (WA) using what is
named a Hankel matrix.
The toolbow thus provides also a class for WA (with a bunch of usefull
methods), another one for Hankel matrix, and a class for loading
data and/or automata, and a class Sample that allows the storage of the
data in a usefull dictionnary form. As WA are a generalisation of
classical Probabilistic Automaton, everything works for these simpler
models.
The core of the learning algorithms is to compute a singular values
decomposition of the Hankel matrix and then to construct the weighted
automata from the elements of the decomposition. This is done in the
class Learning.
In its classic version, the rows of the Hankel matrix are prefixes while
its columns are suffixes. Each cell contains then the probability of the
sequence starting with the corresponding prefix and ending with the
corresponding suffix. In the case of learning, the cells contain
observed frequencies. scikit-splearn provides other versions, where each
cell contains the probability that the corresponding sequence is prefix,
a suffix, or a factor.
Formally, the Hankel matrix is bi-infinite. Hence, in case of learning,
one has to concentrate on a finite portion. The parameters lrows and
lcolumn allows to specified which subsequences are taken into account
as rows and columns of the finite matrix. If, instead of a list,
an integer is provided, the finite matrix will have all rows and
columns that correspond to subsequences up to these given lengths.
The learning method requires also the information about the rank of
the matrix. This rank corresponds to the number of states of a minimal
WA computing the matrix (in case of learning, this is the estimated
number of states of the target automaton). There is no easy way to
evaluate the rank, a cross-validation approach is usually used to find
the best possible value.
Finally, splearn provides 2 ways to store the Hankel matrix:
a classical one as an array, and a sparse version using scipy.sparse.
The original scikit-splearn Toolbox is developed in Python at
`LabEx Archimède <http://labex-archimede.univ-amu.fr/>`_, as a
`LIF <http://www.lif.univ-mrs.fr/>`_ and I2M
project, Aix-Marseille Université.
This package, as well as the scikit-splearn toolbox, is Free software,
released under BSD License.
The latest version of **scikit-splearn** can be downloaded
from the following
`PyPI page `pythonhosted site <http://pythonhosted.org/scikit-splearn/>`_.
The documentation is available as a
`pythonhosted site <http://pythonhosted.org/scikit-splearn/>`_.
`gitlab project <https://gitlab.lif.univ-mrs.fr/dominique.benielli/scikit-splearn>`_,
which provides the git repository managing the source code and where
issues can be reported.
splearn:1.0.1
\ No newline at end of file
# -*- coding: utf-8 -*-
from __future__ import print_function, division
import time
import os
import sys
import fileinput
def findFiles(directory, files=[]):
"""scan a directory for py, pyx, pxd extension files."""
for filename in os.listdir(directory):
path = os.path.join(directory, filename)
if os.path.isfile(path) and (path.endswith(".py") or
path.endswith(".pyx") or
path.endswith(".pxd")):
if filename != "__init__.py" and filename != "version.py":
files.append(path)
elif os.path.isdir(path):
findFiles(path, files)
return files
def fileUnStamping(filename):
""" Remove stamp from a file """
is_stamp = False
for line in fileinput.input(filename, inplace=1):
if line.find("# COPYRIGHT #") != -1:
is_stamp = not is_stamp
elif not is_stamp:
print(line, end="")
def fileStamping(filename, stamp):
""" Write a stamp on a file
WARNING : The stamping must be done on an default utf8 machine !
"""
old_stamp = False # If a copyright already exist over write it.
for line in fileinput.input(filename, inplace=1):
if line.find("# COPYRIGHT #") != -1:
old_stamp = not old_stamp
elif line.startswith("# -*- coding: utf-8 -*-"):
print(line, end="")
print(stamp)
elif not old_stamp:
print(line, end="")
def getStamp(date, scikit_splearn_version):
""" Return the corrected formated stamp """
stamp = open("copyrightstamp.txt").read()
stamp = stamp.replace("DATE", date)
stamp = stamp.replace("SCIKIT-SPLEARN_VERSION", scikit_splearn_version)
stamp = stamp.replace('\n', '\n# ')
stamp = "# " + stamp
stamp = stamp.replace("# \n", "#\n")
return stamp.strip()
def getVersionsAndDate():
""" Return (date, SP2Learning_version) """
v_text = open('VERSION').read().strip()
v_text_formted = '{"' + v_text.replace('\n', '","').replace(':', '":"')
v_text_formted += '"}'
v_dict = eval(v_text_formted)
return (time.strftime("%Y"), v_dict['splearn'])
def writeStamp():
""" Write a copyright stamp on all files """
stamp = getStamp(*getVersionsAndDate())
files = findFiles(os.path.join(os.path.dirname(os.path.abspath(__file__)),
"splearn"))
for filename in files:
fileStamping(filename, stamp)
fileStamping("setup.py", stamp)
def eraseStamp():
""" Erase a copyright stamp from all files """
files = findFiles(os.path.join(os.path.dirname(os.path.abspath(__file__)),
"splearn"))
for filename in files:
fileUnStamping(filename)
fileUnStamping("setup.py")
def usage(arg):
print("Usage :")
print("\tpython %s stamping" % arg)
print("\tpython %s unstamping" % arg)
if __name__ == "__main__":
if len(sys.argv) == 1:
usage(sys.argv[0])
elif len(sys.argv) == 2:
if sys.argv[1].startswith("unstamping"):
eraseStamp()
elif sys.argv[1].startswith("stamping"):
writeStamp()
else:
usage(sys.argv[0])
else:
usage(sys.argv[0])
######### COPYRIGHT #########
Copyright(c) DATE
-----------------
* LabEx Archimède: http://labex-archimede.univ-amu.fr/
* Laboratoire d'Informatique Fondamentale : http://www.lif.univ-mrs.fr/
Contributors:
------------
* François Denis <francois.denis_AT_lif.univ-mrs.fr>
* Rémy Eyraud <remy.eyraud_AT_lif.univ-mrs.fr>
* Denis Arrivault <contact.dev_AT_lif.univ-mrs.fr>
* Dominique Benielli <dominique.benielli_AT_univ-amu.fr>
Description:
-----------
scitkit-splearn is a toolbox in
python for spectral learning algorithms.
Version:
-------
* splearn version = SCIKIT-SPLEARN_VERSION
Licence:
-------
License: 3-clause BSD
######### COPYRIGHT #########
\ No newline at end of file
.. -*- mode: rst -*-
History
-------
People
------
.. hlist::
* François Denis
* Rémi Eyraud
* Denis Arrivault
* Dominique Benielli
.. :changelog:
History
=======
1.0.0 (2016-06-30)
------------------
First version
1.0.1 (2016-10-07)
------------------
Bug setup correction
\ No newline at end of file
Metadata-Version: 1.1
Name: scikit-splearn
Version: 1.0.1
Summary: Python module for spectral learning of weighted automata
Home-page: https://gitlab.lif.univ-mrs.fr/dominique.benielli/scikit-splearn.git
Author: François Denis and Rémi Eyraud and Denis Arrivault and Dominique Benielli
Author-email: francois.denis@lif.univ-mrs.fr remi.eyraud[A]lif.uni-mrs.fr.antispamdenis.arrivault@lif.univ-mrs.fr dominique.benielli@univ-amu.fr
License: new BSD
Description: The **SCIKIT-SPLEARN** package is a Python tool of the
`Scikit-Spectral Learning (scikit-splearn)
<http://splearning.sourceforge.net/>`_, scikit-splearn is a toolbox in
python for spectral learning algorithms.
scikit-splearn is a sckit compatible SP2Learning toolbox.
scikit-splearn is a toolbox in python for spectral learning algorithms.
These algorithms aim at learning Weighted Automata (WA) using what is
named a Hankel matrix.
The toolbow thus provides also a class for WA (with a bunch of usefull
methods), another one for Hankel matrix, and a class for loading
data and/or automata, and a class Sample that allows the storage of the
data in a usefull dictionnary form. As WA are a generalisation of
classical Probabilistic Automaton, everything works for these simpler
models.
The core of the learning algorithms is to compute a singular values
decomposition of the Hankel matrix and then to construct the weighted
automata from the elements of the decomposition. This is done in the
class Learning.
In its classic version, the rows of the Hankel matrix are prefixes while
its columns are suffixes. Each cell contains then the probability of the
sequence starting with the corresponding prefix and ending with the
corresponding suffix. In the case of learning, the cells contain
observed frequencies. scikit-splearn provides other versions, where each
cell contains the probability that the corresponding sequence is prefix,
a suffix, or a factor.
Formally, the Hankel matrix is bi-infinite. Hence, in case of learning,
one has to concentrate on a finite portion. The parameters lrows and
lcolumn allows to specified which subsequences are taken into account
as rows and columns of the finite matrix. If, instead of a list,
an integer is provided, the finite matrix will have all rows and
columns that correspond to subsequences up to these given lengths.
The learning method requires also the information about the rank of
the matrix. This rank corresponds to the number of states of a minimal
WA computing the matrix (in case of learning, this is the estimated
number of states of the target automaton). There is no easy way to
evaluate the rank, a cross-validation approach is usually used to find
the best possible value.
Finally, splearn provides 2 ways to store the Hankel matrix:
a classical one as an array, and a sparse version using scipy.sparse.
The original scikit-splearn Toolbox is developed in Python at
`LabEx Archimède <http://labex-archimede.univ-amu.fr/>`_, as a
`LIF <http://www.lif.univ-mrs.fr/>`_ and I2M
project, Aix-Marseille Université.
This package, as well as the scikit-splearn toolbox, is Free software,
released under BSD License.
The latest version of **scikit-splearn** can be downloaded
from the following
`PyPI page `pythonhosted site <http://pythonhosted.org/scikit-splearn/>`_.
The documentation is available as a
`pythonhosted site <http://pythonhosted.org/scikit-splearn/>`_.
`gitlab project <https://gitlab.lif.univ-mrs.fr/dominique.benielli/scikit-splearn>`_,
which provides the git repository managing the source code and where
issues can be reported.
.. :changelog:
History
=======
1.0.0 (2016-06-30)
------------------
First version
1.0.1 (2016-10-07)
------------------
Bug setup correction
.. -*- mode: rst -*-
History
-------
People
------
.. hlist::
* François Denis
* Rémi Eyraud
* Denis Arrivault
* Dominique Benielli
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
The **SCIKIT-SPLEARN** package is a Python tool of the
`Scikit-Spectral Learning (scikit-splearn)
<http://splearning.sourceforge.net/>`_, scikit-splearn is a toolbox in
python for spectral learning algorithms.
scikit-splearn is a sckit compatible SP2Learning toolbox.
scikit-splearn is a toolbox in python for spectral learning algorithms.
These algorithms aim at learning Weighted Automata (WA) using what is
named a Hankel matrix.
The toolbow thus provides also a class for WA (with a bunch of usefull
methods), another one for Hankel matrix, and a class for loading
data and/or automata, and a class Sample that allows the storage of the
data in a usefull dictionnary form. As WA are a generalisation of
classical Probabilistic Automaton, everything works for these simpler
models.
The core of the learning algorithms is to compute a singular values
decomposition of the Hankel matrix and then to construct the weighted
automata from the elements of the decomposition. This is done in the
class Learning.
In its classic version, the rows of the Hankel matrix are prefixes while
its columns are suffixes. Each cell contains then the probability of the
sequence starting with the corresponding prefix and ending with the
corresponding suffix. In the case of learning, the cells contain
observed frequencies. scikit-splearn provides other versions, where each
cell contains the probability that the corresponding sequence is prefix,
a suffix, or a factor.
Formally, the Hankel matrix is bi-infinite. Hence, in case of learning,
one has to concentrate on a finite portion. The parameters lrows and
lcolumn allows to specified which subsequences are taken into account
as rows and columns of the finite matrix. If, instead of a list,
an integer is provided, the finite matrix will have all rows and
columns that correspond to subsequences up to these given lengths.
The learning method requires also the information about the rank of
the matrix. This rank corresponds to the number of states of a minimal
WA computing the matrix (in case of learning, this is the estimated
number of states of the target automaton). There is no easy way to
evaluate the rank, a cross-validation approach is usually used to find
the best possible value.
Finally, splearn provides 2 ways to store the Hankel matrix:
a classical one as an array, and a sparse version using scipy.sparse.
The original scikit-splearn Toolbox is developed in Python at
`LabEx Archimède <http://labex-archimede.univ-amu.fr/>`_, as a
`LIF <http://www.lif.univ-mrs.fr/>`_ and I2M
project, Aix-Marseille Université.
This package, as well as the scikit-splearn toolbox, is Free software,
released under BSD License.
The latest version of **scikit-splearn** can be downloaded
from the following
`PyPI page `pythonhosted site <http://pythonhosted.org/scikit-splearn/>`_.
The documentation is available as a
`pythonhosted site <http://pythonhosted.org/scikit-splearn/>`_.
`gitlab project <https://gitlab.lif.univ-mrs.fr/dominique.benielli/scikit-splearn>`_,
which provides the git repository managing the source code and where
issues can be reported.
splearn:1.0.1
\ No newline at end of file
automaton module
================
.. automodule:: automaton
:members:
:undoc-members:
:show-inheritance:
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# scikit-splearn documentation build configuration file, created by
# sphinx-quickstart on Fri Nov 6 17:21:52 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
import shlex
# If extensions (or modules to document with autodoc) are in another directory,
# 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.
sys.path.insert(0, os.path.abspath('../splearn'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.imgmath'
]
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'scikit-splearn'
copyright = '2016, François Denis, Rémi Eyraud and Denis Arrivault and Dominique Benielli'
author = 'François Denis, Rémi Eyraud and Denis Arrivault and Dominique Benielli'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1'
# The full version, including alpha/beta/rc tags.
release = '0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# 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
# a list of builtin themes.
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
#html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'scikit-splearndoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
# Latex figure (float) alignment
#'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'scikit-splearn.tex', 'scikit splearn Documentation',
'François Denis, Rémi Eyraud, Denis Arrivault and dominique Benielli',
'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'scikit-splearn', 'scikit splearn Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'scikit-splearn', 'scikit splearn Documentation',
author, 'scikit-splearn', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
hankel module
===============
.. automodule:: hankel
:members:
:undoc-members:
:show-inheritance:
.. scikit-splearn documentation master file, created by
sphinx-quickstart on Fri Nov 6 17:21:52 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to scikit-splearn's documentation!
==========================================
Contents:
.. toctree::
:maxdepth: 3
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
splearn
=======
.. toctree::
:maxdepth: 2
automaton
spectral
hankel
splearn.datasets
spectral module
===============
.. automodule:: spectral
:members: Learning, Spectral
:undoc-members:
:show-inheritance:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment