Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
4
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Switch to GitLab Next
Sign in / Register
Toggle navigation
aGrUM
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Iterations
Merge Requests
0
Merge Requests
0
Requirements
Requirements
List
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
Code Review
Insights
Issue
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
agrumery
aGrUM
Commits
a926af08
Commit
a926af08
authored
May 30, 2017
by
Pierre-Henri Wuillemin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[pyAgrum] trying a new framework for pyAgrum documentation
parent
14a76840
Changes
31
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
31 changed files
with
1836 additions
and
0 deletions
+1836
-0
wrappers/pyAgrum/doc/Makefile.win
wrappers/pyAgrum/doc/Makefile.win
+5
-0
wrappers/pyAgrum/doc/README_windows.rst
wrappers/pyAgrum/doc/README_windows.rst
+8
-0
wrappers/pyAgrum/doc/classes/BayesNet.i
wrappers/pyAgrum/doc/classes/BayesNet.i
+15
-0
wrappers/pyAgrum/doc/sphinx/Makefile
wrappers/pyAgrum/doc/sphinx/Makefile
+226
-0
wrappers/pyAgrum/doc/sphinx/Makefile.win
wrappers/pyAgrum/doc/sphinx/Makefile.win
+226
-0
wrappers/pyAgrum/doc/sphinx/PRM.rst
wrappers/pyAgrum/doc/sphinx/PRM.rst
+7
-0
wrappers/pyAgrum/doc/sphinx/_static/agrum.png
wrappers/pyAgrum/doc/sphinx/_static/agrum.png
+0
-0
wrappers/pyAgrum/doc/sphinx/_static/bn2graph_test.png
wrappers/pyAgrum/doc/sphinx/_static/bn2graph_test.png
+0
-0
wrappers/pyAgrum/doc/sphinx/_static/dBN.png
wrappers/pyAgrum/doc/sphinx/_static/dBN.png
+0
-0
wrappers/pyAgrum/doc/sphinx/_static/dBN.xcf
wrappers/pyAgrum/doc/sphinx/_static/dBN.xcf
+0
-0
wrappers/pyAgrum/doc/sphinx/_static/fastBNwithPyAgrum.ipynb
wrappers/pyAgrum/doc/sphinx/_static/fastBNwithPyAgrum.ipynb
+253
-0
wrappers/pyAgrum/doc/sphinx/_static/fastBNwithPyAgrum.png
wrappers/pyAgrum/doc/sphinx/_static/fastBNwithPyAgrum.png
+0
-0
wrappers/pyAgrum/doc/sphinx/_static/pyAgrum.png
wrappers/pyAgrum/doc/sphinx/_static/pyAgrum.png
+0
-0
wrappers/pyAgrum/doc/sphinx/_static/pyAgrum_all.png
wrappers/pyAgrum/doc/sphinx/_static/pyAgrum_all.png
+0
-0
wrappers/pyAgrum/doc/sphinx/bayesianNetwork.rst
wrappers/pyAgrum/doc/sphinx/bayesianNetwork.rst
+32
-0
wrappers/pyAgrum/doc/sphinx/conf.py
wrappers/pyAgrum/doc/sphinx/conf.py
+535
-0
wrappers/pyAgrum/doc/sphinx/credalNetwork.rst
wrappers/pyAgrum/doc/sphinx/credalNetwork.rst
+22
-0
wrappers/pyAgrum/doc/sphinx/exceptions.rst
wrappers/pyAgrum/doc/sphinx/exceptions.rst
+69
-0
wrappers/pyAgrum/doc/sphinx/functions.rst
wrappers/pyAgrum/doc/sphinx/functions.rst
+23
-0
wrappers/pyAgrum/doc/sphinx/graph.rst
wrappers/pyAgrum/doc/sphinx/graph.rst
+31
-0
wrappers/pyAgrum/doc/sphinx/index.rst
wrappers/pyAgrum/doc/sphinx/index.rst
+76
-0
wrappers/pyAgrum/doc/sphinx/influenceDiagram.rst
wrappers/pyAgrum/doc/sphinx/influenceDiagram.rst
+17
-0
wrappers/pyAgrum/doc/sphinx/lib.bn2graph.rst
wrappers/pyAgrum/doc/sphinx/lib.bn2graph.rst
+43
-0
wrappers/pyAgrum/doc/sphinx/lib.dBN.rst
wrappers/pyAgrum/doc/sphinx/lib.dBN.rst
+10
-0
wrappers/pyAgrum/doc/sphinx/lib.notebook.rst
wrappers/pyAgrum/doc/sphinx/lib.notebook.rst
+49
-0
wrappers/pyAgrum/doc/sphinx/miscellaneous.rst
wrappers/pyAgrum/doc/sphinx/miscellaneous.rst
+24
-0
wrappers/pyAgrum/doc/sphinx/potential.rst
wrappers/pyAgrum/doc/sphinx/potential.rst
+14
-0
wrappers/pyAgrum/doc/sphinx/pyAgrum.lib.rst
wrappers/pyAgrum/doc/sphinx/pyAgrum.lib.rst
+51
-0
wrappers/pyAgrum/doc/sphinx/pyAgrum.py
wrappers/pyAgrum/doc/sphinx/pyAgrum.py
+0
-0
wrappers/pyAgrum/doc/sphinx/randomVariables.rst
wrappers/pyAgrum/doc/sphinx/randomVariables.rst
+22
-0
wrappers/pyAgrum/doc/sphinx/sphinx_warnings.txt
wrappers/pyAgrum/doc/sphinx/sphinx_warnings.txt
+78
-0
No files found.
wrappers/pyAgrum/doc/Makefile.win
0 → 100644
View file @
a926af08
DESTDIR
=
$(
shell
python
-c
"import os;import pyAgrum;print(os.path.dirname(pyAgrum.__file__
))
"
)
run
:
swig
-c
++
-python
-outdir
$(DESTDIR)
-py3
-I
..
\.
.
\s
wig
-I
..
\.
.
\.
.
\s
rc
-I
..
\.
.
\.
.
\b
uild
\R
elease
-I
.. pyAgrum.i
cd
sphinx
&&
make
-f
Makefile.win html
wrappers/pyAgrum/doc/README_windows.rst
0 → 100644
View file @
a926af08
For Windows
===========
- install conda
- conda install sphinx swig cmake
- git clone [aGrUM@gitlab]
- git checkout documentation/swigDoc
-
wrappers/pyAgrum/doc/classes/BayesNet.i
0 → 100644
View file @
a926af08
%
feature
(
"docstring"
)
gum
::
BayesNet
"
C'est un fameux 3 mats
Parameters
==========
problem : :class:`~openturns.OptimizationProblem`
Optimization problem to solve.
tau : float
Multiplicative decrease of linear step.
omega : float
Armijo factor.
smooth : float
Growing factor in penalization term.
"
wrappers/pyAgrum/doc/sphinx/Makefile
0 → 100644
View file @
a926af08
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS
=
-c
.
-a
-E
-w
sphinx_warnings.txt
SPHINXBUILD
=
python3
`
which sphinx-build
`
PAPER
=
BUILDDIR
=
../../../build/release/wrappers/pyAgrum/docs
AGRUMBUILDDIR
=
"{agrum}/build/release/wrappers/pyAgrum/docs"
# Internal variables.
PAPEROPT_a4
=
-D
latex_paper_size
=
a4
PAPEROPT_letter
=
-D
latex_paper_size
=
letter
ALLSPHINXOPTS
=
-d
$(BUILDDIR)
/doctrees
$
(
PAPEROPT_
$(PAPER)
)
$(SPHINXOPTS)
.
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS
=
$
(
PAPEROPT_
$(PAPER)
)
$(SPHINXOPTS)
.
.PHONY
:
help
help
:
@
echo
"Please use
\`
make <target>' where <target> is one of"
@
echo
" html to make standalone HTML files"
@
echo
" dirhtml to make HTML files named index.html in directories"
@
echo
" singlehtml to make a single large HTML file"
@
echo
" pickle to make pickle files"
@
echo
" json to make JSON files"
@
echo
" htmlhelp to make HTML files and a HTML help project"
@
echo
" qthelp to make HTML files and a qthelp project"
@
echo
" applehelp to make an Apple Help Book"
@
echo
" devhelp to make HTML files and a Devhelp project"
@
echo
" epub to make an epub"
@
echo
" epub3 to make an epub3"
@
echo
" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@
echo
" latexpdf to make LaTeX files and run them through pdflatex"
@
echo
" latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@
echo
" text to make text files"
@
echo
" man to make manual pages"
@
echo
" texinfo to make Texinfo files"
@
echo
" info to make Texinfo files and run them through makeinfo"
@
echo
" gettext to make PO message catalogs"
@
echo
" changes to make an overview of all changed/added/deprecated items"
@
echo
" xml to make Docutils-native XML files"
@
echo
" pseudoxml to make pseudoxml-XML files for display purposes"
@
echo
" linkcheck to check all external links for integrity"
@
echo
" doctest to run all doctests embedded in the documentation (if enabled)"
@
echo
" coverage to run coverage check of the documentation (if enabled)"
@
echo
" dummy to check syntax errors of document sources"
.PHONY
:
clean
clean
:
rm
-rf
$(BUILDDIR)
/
*
.PHONY
:
html
html
:
$(SPHINXBUILD)
-b
html
$(ALLSPHINXOPTS)
$(BUILDDIR)
/html
@
echo
@
echo
"Build finished. The HTML pages are in
$(AGRUMBUILDDIR)
/html."
.PHONY
:
dirhtml
dirhtml
:
$(SPHINXBUILD)
-b
dirhtml
$(ALLSPHINXOPTS)
$(BUILDDIR)
/dirhtml
@
echo
@
echo
"Build finished. The HTML pages are in
$(AGRUMBUILDDIR)
/dirhtml."
.PHONY
:
singlehtml
singlehtml
:
$(SPHINXBUILD)
-b
singlehtml
$(ALLSPHINXOPTS)
$(BUILDDIR)
/singlehtml
@
echo
@
echo
"Build finished. The HTML page is in
$(BUILDDIR)
/singlehtml."
.PHONY
:
pickle
pickle
:
$(SPHINXBUILD)
-b
pickle
$(ALLSPHINXOPTS)
$(BUILDDIR)
/pickle
@
echo
@
echo
"Build finished; now you can process the pickle files."
.PHONY
:
json
json
:
$(SPHINXBUILD)
-b
json
$(ALLSPHINXOPTS)
$(BUILDDIR)
/json
@
echo
@
echo
"Build finished; now you can process the JSON files."
.PHONY
:
htmlhelp
htmlhelp
:
$(SPHINXBUILD)
-b
htmlhelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
/htmlhelp
@
echo
@
echo
"Build finished; now you can run HTML Help Workshop with the"
\
".hhp project file in
$(BUILDDIR)
/htmlhelp."
.PHONY
:
qthelp
qthelp
:
$(SPHINXBUILD)
-b
qthelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
/qthelp
@
echo
@
echo
"Build finished; now you can run "
qcollectiongenerator
" with the"
\
".qhcp project file in
$(BUILDDIR)
/qthelp, like this:"
@
echo
"# qcollectiongenerator
$(BUILDDIR)
/qthelp/pyAgrum.qhcp"
@
echo
"To view the help file:"
@
echo
"# assistant -collectionFile
$(BUILDDIR)
/qthelp/pyAgrum.qhc"
.PHONY
:
applehelp
applehelp
:
$(SPHINXBUILD)
-b
applehelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
/applehelp
@
echo
@
echo
"Build finished. The help book is in
$(BUILDDIR)
/applehelp."
@
echo
"N.B. You won't be able to view it unless you put it in"
\
"~/Library/Documentation/Help or install it in your application"
\
"bundle."
.PHONY
:
devhelp
devhelp
:
$(SPHINXBUILD)
-b
devhelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
/devhelp
@
echo
@
echo
"Build finished."
@
echo
"To view the help file:"
@
echo
"# mkdir -p
$$
HOME/.local/share/devhelp/pyAgrum"
@
echo
"# ln -s
$(BUILDDIR)
/devhelp
$$
HOME/.local/share/devhelp/pyAgrum"
@
echo
"# devhelp"
.PHONY
:
epub
epub
:
$(SPHINXBUILD)
-b
epub
$(ALLSPHINXOPTS)
$(BUILDDIR)
/epub
@
echo
@
echo
"Build finished. The epub file is in
$(BUILDDIR)
/epub."
.PHONY
:
epub3
epub3
:
$(SPHINXBUILD)
-b
epub3
$(ALLSPHINXOPTS)
$(BUILDDIR)
/epub3
@
echo
@
echo
"Build finished. The epub3 file is in
$(BUILDDIR)
/epub3."
.PHONY
:
latex
latex
:
$(SPHINXBUILD)
-b
latex
$(ALLSPHINXOPTS)
$(BUILDDIR)
/latex
@
echo
@
echo
"Build finished; the LaTeX files are in
$(AGRUMBUILDDIR)
/latex."
@
echo
"Run
\`
make' in that directory to run these through (pdf)latex"
\
"(use
\`
make latexpdf' here to do that automatically)."
.PHONY
:
latexpdf
latexpdf
:
$(SPHINXBUILD)
-b
latex
$(ALLSPHINXOPTS)
$(BUILDDIR)
/latex
@
echo
"Running LaTeX files through pdflatex..."
$(MAKE)
-C
$(BUILDDIR)
/latex all-pdf
@
echo
"pdflatex finished; the PDF files are in
$(AGRUMBUILDDIR)
/latex."
.PHONY
:
latexpdfja
latexpdfja
:
$(SPHINXBUILD)
-b
latex
$(ALLSPHINXOPTS)
$(BUILDDIR)
/latex
@
echo
"Running LaTeX files through platex and dvipdfmx..."
$(MAKE)
-C
$(BUILDDIR)
/latex all-pdf-ja
@
echo
"pdflatex finished; the PDF files are in
$(AGRUMBUILDDIR)
/latex."
.PHONY
:
text
text
:
$(SPHINXBUILD)
-b
text
$(ALLSPHINXOPTS)
$(BUILDDIR)
/text
@
echo
@
echo
"Build finished. The text files are in
$(AGRUMBUILDDIR)
/text."
.PHONY
:
man
man
:
$(SPHINXBUILD)
-b
man
$(ALLSPHINXOPTS)
$(BUILDDIR)
/man
@
echo
@
echo
"Build finished. The manual pages are in
$(AGRUMBUILDDIR)
/man."
.PHONY
:
texinfo
texinfo
:
$(SPHINXBUILD)
-b
texinfo
$(ALLSPHINXOPTS)
$(BUILDDIR)
/texinfo
@
echo
@
echo
"Build finished. The Texinfo files are in
$(AGRUMBUILDDIR)
/texinfo."
@
echo
"Run
\`
make' in that directory to run these through makeinfo"
\
"(use
\`
make info' here to do that automatically)."
.PHONY
:
info
info
:
$(SPHINXBUILD)
-b
texinfo
$(ALLSPHINXOPTS)
$(BUILDDIR)
/texinfo
@
echo
"Running Texinfo files through makeinfo..."
make
-C
$(BUILDDIR)
/texinfo info
@
echo
"makeinfo finished; the Info files are in
$(AGRUMBUILDDIR)
/texinfo."
.PHONY
:
gettext
gettext
:
$(SPHINXBUILD)
-b
gettext
$(I18NSPHINXOPTS)
$(BUILDDIR)
/locale
@
echo
@
echo
"Build finished. The message catalogs are in
$(AGRUMBUILDDIR)
/locale."
.PHONY
:
changes
changes
:
$(SPHINXBUILD)
-b
changes
$(ALLSPHINXOPTS)
$(BUILDDIR)
/changes
@
echo
@
echo
"The overview file is in
$(BUILDDIR)
/changes."
.PHONY
:
linkcheck
linkcheck
:
$(SPHINXBUILD)
-b
linkcheck
$(ALLSPHINXOPTS)
$(BUILDDIR)
/linkcheck
@
echo
@
echo
"Link check complete; look for any errors in the above output "
\
"or in
$(BUILDDIR)
/linkcheck/output.txt."
.PHONY
:
doctest
doctest
:
$(SPHINXBUILD)
-b
doctest
$(ALLSPHINXOPTS)
$(BUILDDIR)
/doctest
@
echo
"Testing of doctests in the sources finished, look at the "
\
"results in
$(BUILDDIR)
/doctest/output.txt."
.PHONY
:
coverage
coverage
:
$(SPHINXBUILD)
-b
coverage
$(ALLSPHINXOPTS)
$(BUILDDIR)
/coverage
@
echo
"Testing of coverage in the sources finished, look at the "
\
"results in
$(BUILDDIR)
/coverage/python.txt."
.PHONY
:
xml
xml
:
$(SPHINXBUILD)
-b
xml
$(ALLSPHINXOPTS)
$(BUILDDIR)
/xml
@
echo
@
echo
"Build finished. The XML files are in
$(AGRUMBUILDDIR)
/xml."
.PHONY
:
pseudoxml
pseudoxml
:
$(SPHINXBUILD)
-b
pseudoxml
$(ALLSPHINXOPTS)
$(BUILDDIR)
/pseudoxml
@
echo
@
echo
"Build finished. The pseudo-XML files are in
$(AGRUMBUILDDIR)
/pseudoxml."
.PHONY
:
dummy
dummy
:
$(SPHINXBUILD)
-b
dummy
$(ALLSPHINXOPTS)
$(BUILDDIR)
/dummy
@
echo
@
echo
"Build finished. Dummy builder generates no files."
wrappers/pyAgrum/doc/sphinx/Makefile.win
0 → 100644
View file @
a926af08
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS
=
-c
.
-a
-E
-w
sphinx_warnings.txt
SPHINXBUILD
=
sphinx-build.exe
PAPER
=
BUILDDIR
=
outputs
AGRUMBUILDDIR
=
$(BUILDIR)
# Internal variables.
PAPEROPT_a4
=
-D
latex_paper_size
=
a4
PAPEROPT_letter
=
-D
latex_paper_size
=
letter
ALLSPHINXOPTS
=
-d
$(BUILDDIR)
\d
octrees
$
(
PAPEROPT_
$(PAPER)
)
$(SPHINXOPTS)
.
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS
=
$
(
PAPEROPT_
$(PAPER)
)
$(SPHINXOPTS)
.
.PHONY
:
help
help
:
@
echo
"Please use
\`
make <target>' where <target> is one of"
@
echo
" html to make standalone HTML files"
@
echo
" dirhtml to make HTML files named index.html in directories"
@
echo
" singlehtml to make a single large HTML file"
@
echo
" pickle to make pickle files"
@
echo
" json to make JSON files"
@
echo
" htmlhelp to make HTML files and a HTML help project"
@
echo
" qthelp to make HTML files and a qthelp project"
@
echo
" applehelp to make an Apple Help Book"
@
echo
" devhelp to make HTML files and a Devhelp project"
@
echo
" epub to make an epub"
@
echo
" epub3 to make an epub3"
@
echo
" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@
echo
" latexpdf to make LaTeX files and run them through pdflatex"
@
echo
" latexpdfja to make LaTeX files and run them through platex
\d
vipdfmx"
@
echo
" text to make text files"
@
echo
" man to make manual pages"
@
echo
" texinfo to make Texinfo files"
@
echo
" info to make Texinfo files and run them through makeinfo"
@
echo
" gettext to make PO message catalogs"
@
echo
" changes to make an overview of all changed
\a
dded
\d
eprecated items"
@
echo
" xml to make Docutils-native XML files"
@
echo
" pseudoxml to make pseudoxml-XML files for display purposes"
@
echo
" linkcheck to check all external links for integrity"
@
echo
" doctest to run all doctests embedded in the documentation (if enabled)"
@
echo
" coverage to run coverage check of the documentation (if enabled)"
@
echo
" dummy to check syntax errors of document sources"
.PHONY
:
clean
clean
:
rm
-rf
$(BUILDDIR)
\*
.PHONY
:
html
html
:
$(SPHINXBUILD)
-b
html
$(ALLSPHINXOPTS)
$(BUILDDIR)
\h
tml
@
echo
@
echo
"Build finished. The HTML pages are in
$(AGRUMBUILDDIR)
\h
tml."
.PHONY
:
dirhtml
dirhtml
:
$(SPHINXBUILD)
-b
dirhtml
$(ALLSPHINXOPTS)
$(BUILDDIR)
\d
irhtml
@
echo
@
echo
"Build finished. The HTML pages are in
$(AGRUMBUILDDIR)
\d
irhtml."
.PHONY
:
singlehtml
singlehtml
:
$(SPHINXBUILD)
-b
singlehtml
$(ALLSPHINXOPTS)
$(BUILDDIR)
\s
inglehtml
@
echo
@
echo
"Build finished. The HTML page is in
$(BUILDDIR)
\s
inglehtml."
.PHONY
:
pickle
pickle
:
$(SPHINXBUILD)
-b
pickle
$(ALLSPHINXOPTS)
$(BUILDDIR)
\p
ickle
@
echo
@
echo
"Build finished; now you can process the pickle files."
.PHONY
:
json
json
:
$(SPHINXBUILD)
-b
json
$(ALLSPHINXOPTS)
$(BUILDDIR)
\j
son
@
echo
@
echo
"Build finished; now you can process the JSON files."
.PHONY
:
htmlhelp
htmlhelp
:
$(SPHINXBUILD)
-b
htmlhelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
\h
tmlhelp
@
echo
@
echo
"Build finished; now you can run HTML Help Workshop with the"
\
".hhp project file in
$(BUILDDIR)
\h
tmlhelp."
.PHONY
:
qthelp
qthelp
:
$(SPHINXBUILD)
-b
qthelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
\q
thelp
@
echo
@
echo
"Build finished; now you can run "
qcollectiongenerator
" with the"
\
".qhcp project file in
$(BUILDDIR)
\q
thelp, like this:"
@
echo
"# qcollectiongenerator
$(BUILDDIR)
\q
thelp
\p
yAgrum.qhcp"
@
echo
"To view the help file:"
@
echo
"# assistant -collectionFile
$(BUILDDIR)
\q
thelp
\p
yAgrum.qhc"
.PHONY
:
applehelp
applehelp
:
$(SPHINXBUILD)
-b
applehelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
\a
pplehelp
@
echo
@
echo
"Build finished. The help book is in
$(BUILDDIR)
\a
pplehelp."
@
echo
"N.B. You won't be able to view it unless you put it in"
\
"~
\L
ibrary
\D
ocumentation
\H
elp or install it in your application"
\
"bundle."
.PHONY
:
devhelp
devhelp
:
$(SPHINXBUILD)
-b
devhelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
\d
evhelp
@
echo
@
echo
"Build finished."
@
echo
"To view the help file:"
@
echo
"# mkdir -p
$$
HOME
\.
local
\s
hare
\d
evhelp
\p
yAgrum"
@
echo
"# ln -s
$(BUILDDIR)
\d
evhelp
$$
HOME
\.
local
\s
hare
\d
evhelp
\p
yAgrum"
@
echo
"# devhelp"
.PHONY
:
epub
epub
:
$(SPHINXBUILD)
-b
epub
$(ALLSPHINXOPTS)
$(BUILDDIR)
\e
pub
@
echo
@
echo
"Build finished. The epub file is in
$(BUILDDIR)
\e
pub."
.PHONY
:
epub3
epub3
:
$(SPHINXBUILD)
-b
epub3
$(ALLSPHINXOPTS)
$(BUILDDIR)
\e
pub3
@
echo
@
echo
"Build finished. The epub3 file is in
$(BUILDDIR)
\e
pub3."
.PHONY
:
latex
latex
:
$(SPHINXBUILD)
-b
latex
$(ALLSPHINXOPTS)
$(BUILDDIR)
\l
atex
@
echo
@
echo
"Build finished; the LaTeX files are in
$(AGRUMBUILDDIR)
\l
atex."
@
echo
"Run
\`
make' in that directory to run these through (pdf)latex"
\
"(use
\`
make latexpdf' here to do that automatically)."
.PHONY
:
latexpdf
latexpdf
:
$(SPHINXBUILD)
-b
latex
$(ALLSPHINXOPTS)
$(BUILDDIR)
\l
atex
@
echo
"Running LaTeX files through pdflatex..."
$(MAKE)
-C
$(BUILDDIR)
\l
atex all-pdf
@
echo
"pdflatex finished; the PDF files are in
$(AGRUMBUILDDIR)
\l
atex."
.PHONY
:
latexpdfja
latexpdfja
:
$(SPHINXBUILD)
-b
latex
$(ALLSPHINXOPTS)
$(BUILDDIR)
\l
atex
@
echo
"Running LaTeX files through platex and dvipdfmx..."
$(MAKE)
-C
$(BUILDDIR)
\l
atex all-pdf-ja
@
echo
"pdflatex finished; the PDF files are in
$(AGRUMBUILDDIR)
\l
atex."
.PHONY
:
text
text
:
$(SPHINXBUILD)
-b
text
$(ALLSPHINXOPTS)
$(BUILDDIR)
\t
ext
@
echo
@
echo
"Build finished. The text files are in
$(AGRUMBUILDDIR)
\t
ext."
.PHONY
:
man
man
:
$(SPHINXBUILD)
-b
man
$(ALLSPHINXOPTS)
$(BUILDDIR)
\m
an
@
echo
@
echo
"Build finished. The manual pages are in
$(AGRUMBUILDDIR)
\m
an."
.PHONY
:
texinfo
texinfo
:
$(SPHINXBUILD)
-b
texinfo
$(ALLSPHINXOPTS)
$(BUILDDIR)
\t
exinfo
@
echo
@
echo
"Build finished. The Texinfo files are in
$(AGRUMBUILDDIR)
\t
exinfo."
@
echo
"Run
\`
make' in that directory to run these through makeinfo"
\
"(use
\`
make info' here to do that automatically)."
.PHONY
:
info
info
:
$(SPHINXBUILD)
-b
texinfo
$(ALLSPHINXOPTS)
$(BUILDDIR)
\t
exinfo
@
echo
"Running Texinfo files through makeinfo..."
make
-C
$(BUILDDIR)
\t
exinfo info
@
echo
"makeinfo finished; the Info files are in
$(AGRUMBUILDDIR)
\t
exinfo."
.PHONY
:
gettext
gettext
:
$(SPHINXBUILD)
-b
gettext
$(I18NSPHINXOPTS)
$(BUILDDIR)
\l
ocale
@
echo
@
echo
"Build finished. The message catalogs are in
$(AGRUMBUILDDIR)
\l
ocale."
.PHONY
:
changes
changes
:
$(SPHINXBUILD)
-b
changes
$(ALLSPHINXOPTS)
$(BUILDDIR)
\c
hanges
@
echo
@
echo
"The overview file is in
$(BUILDDIR)
\c
hanges."
.PHONY
:
linkcheck
linkcheck
:
$(SPHINXBUILD)
-b
linkcheck
$(ALLSPHINXOPTS)
$(BUILDDIR)
\l
inkcheck
@
echo
@
echo
"Link check complete; look for any errors in the above output "
\
"or in
$(BUILDDIR)
\l
inkcheck
\o
utput.txt."
.PHONY
:
doctest
doctest
:
$(SPHINXBUILD)
-b
doctest
$(ALLSPHINXOPTS)
$(BUILDDIR)
\d
octest
@
echo
"Testing of doctests in the sources finished, look at the "
\
"results in
$(BUILDDIR)
\d
octest
\o
utput.txt."
.PHONY
:
coverage
coverage
:
$(SPHINXBUILD)
-b
coverage
$(ALLSPHINXOPTS)
$(BUILDDIR)
\c
overage
@
echo
"Testing of coverage in the sources finished, look at the "
\
"results in
$(BUILDDIR)
\c
overage
\p
ython.txt."
.PHONY
:
xml
xml
:
$(SPHINXBUILD)
-b
xml
$(ALLSPHINXOPTS)
$(BUILDDIR)
\x
ml
@
echo
@
echo
"Build finished. The XML files are in
$(AGRUMBUILDDIR)
\x
ml."
.PHONY
:
pseudoxml
pseudoxml
:
$(SPHINXBUILD)
-b
pseudoxml
$(ALLSPHINXOPTS)
$(BUILDDIR)
\p
seudoxml
@
echo
@
echo
"Build finished. The pseudo-XML files are in
$(AGRUMBUILDDIR)
\p
seudoxml."
.PHONY
:
dummy
dummy
:
$(SPHINXBUILD)
-b
dummy
$(ALLSPHINXOPTS)
$(BUILDDIR)
\d
ummy
@
echo
@
echo
"Build finished. Dummy builder generates no files."
wrappers/pyAgrum/doc/sphinx/PRM.rst
0 → 100644
View file @
a926af08
Probabilistic Relational Models
===============================
For now, pyAgrum only allows to explore Probabilistic Relational Models written with o3prm syntax.
.. autoclass:: pyAgrum.PRMexplorer
:members:
wrappers/pyAgrum/doc/sphinx/_static/agrum.png
0 → 100644
View file @
a926af08
17 KB
wrappers/pyAgrum/doc/sphinx/_static/bn2graph_test.png
0 → 100644
View file @
a926af08
21.9 KB
wrappers/pyAgrum/doc/sphinx/_static/dBN.png
0 → 100644
View file @
a926af08
174 KB
wrappers/pyAgrum/doc/sphinx/_static/dBN.xcf
0 → 100644
View file @
a926af08
File added
wrappers/pyAgrum/doc/sphinx/_static/fastBNwithPyAgrum.ipynb
0 → 100644
View file @
a926af08
{
"cells": [
{
"cell_type": "code",
"execution_count": 2,
"metadata": {
"collapsed": true,
"deletable": true,
"editable": true
},
"outputs": [],
"source": [
"import pyAgrum as gum\n",
"import pyAgrum.lib.notebook as gnb"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {
"collapsed": false,
"deletable": true,
"editable": true
},
"outputs": [
{
"data": {
"text/html": [
"<table style=\"border-style: hidden; border-collapse: collapse;\" width=\"100%\"><tr><td style=\"border-top:hidden;border-bottom:hidden;\"><div align=\"center\"><svg height=\"188pt\" viewBox=\"0.00 0.00 134.00 188.00\" width=\"134pt\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n",
"<g class=\"graph\" id=\"graph0\" transform=\"scale(1 1) rotate(0) translate(4 184)\">\n",
"<title>G</title>\n",
"<polygon fill=\"white\" points=\"-4,4 -4,-184 130,-184 130,4 -4,4\" stroke=\"none\"/>\n",
"<!-- a -->\n",
"<g class=\"node\" id=\"node1\"><title>a</title>\n",
"<g id=\"a_node1\"><a xlink:title=\"(0) a\">\n",
"<ellipse cx=\"27\" cy=\"-162\" fill=\"#444444\" rx=\"27\" ry=\"18\" stroke=\"black\"/>\n",
"<text fill=\"#ffffff\" font-family=\"Times,serif\" font-size=\"14.00\" text-anchor=\"middle\" x=\"27\" y=\"-158.3\">a</text>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- b -->\n",
"<g class=\"node\" id=\"node2\"><title>b</title>\n",
"<g id=\"a_node2\"><a xlink:title=\"(1) b\">\n",
"<ellipse cx=\"63\" cy=\"-90\" fill=\"#444444\" rx=\"27\" ry=\"18\" stroke=\"black\"/>\n",
"<text fill=\"#ffffff\" font-family=\"Times,serif\" font-size=\"14.00\" text-anchor=\"middle\" x=\"63\" y=\"-86.3\">b</text>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- a->b -->\n",
"<g class=\"edge\" id=\"edge1\"><title>a->b</title>\n",
"<g id=\"a_edge1\"><a xlink:title=\"(0, 1) : \">\n",
"<path d=\"M35.3496,-144.765C39.7115,-136.283 45.1469,-125.714 50.0413,-116.197\" fill=\"none\" stroke=\"black\"/>\n",
"<polygon fill=\"black\" points=\"53.2346,-117.641 54.6957,-107.147 47.0096,-114.439 53.2346,-117.641\" stroke=\"black\"/>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- d -->\n",
"<g class=\"node\" id=\"node4\"><title>d</title>\n",
"<g id=\"a_node4\"><a xlink:title=\"(3) d\">\n",
"<ellipse cx=\"63\" cy=\"-18\" fill=\"#444444\" rx=\"27\" ry=\"18\" stroke=\"black\"/>\n",
"<text fill=\"#ffffff\" font-family=\"Times,serif\" font-size=\"14.00\" text-anchor=\"middle\" x=\"63\" y=\"-14.3\">d</text>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- b->d -->\n",
"<g class=\"edge\" id=\"edge2\"><title>b->d</title>\n",
"<g id=\"a_edge2\"><a xlink:title=\"(1, 3) : \">\n",
"<path d=\"M63,-71.6966C63,-63.9827 63,-54.7125 63,-46.1124\" fill=\"none\" stroke=\"black\"/>\n",
"<polygon fill=\"black\" points=\"66.5001,-46.1043 63,-36.1043 59.5001,-46.1044 66.5001,-46.1043\" stroke=\"black\"/>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- c -->\n",
"<g class=\"node\" id=\"node3\"><title>c</title>\n",
"<g id=\"a_node3\"><a xlink:title=\"(2) c\">\n",
"<ellipse cx=\"99\" cy=\"-162\" fill=\"#444444\" rx=\"27\" ry=\"18\" stroke=\"black\"/>\n",
"<text fill=\"#ffffff\" font-family=\"Times,serif\" font-size=\"14.00\" text-anchor=\"middle\" x=\"99\" y=\"-158.3\">c</text>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- c->b -->\n",
"<g class=\"edge\" id=\"edge3\"><title>c->b</title>\n",
"<g id=\"a_edge3\"><a xlink:title=\"(2, 1) : \">\n",
"<path d=\"M90.6504,-144.765C86.2885,-136.283 80.8531,-125.714 75.9587,-116.197\" fill=\"none\" stroke=\"black\"/>\n",
"<polygon fill=\"black\" points=\"78.9904,-114.439 71.3043,-107.147 72.7654,-117.641 78.9904,-114.439\" stroke=\"black\"/>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"</g>\n",
"</svg></div></td><td style=\"border-top:hidden;border-bottom:hidden;\"><div align=\"center\"><table>\n",
"<tr><th colspan='2'></th><th colspan='3' style='background-color:#AAAAAA'><center>b</center></th></tr>\n",