Skip to content

Commit be58fed

Browse files
KrotosBenjaminKrotosBenjamin
committed
updating files to ignore and adding missing rst documentation
1 parent 8e018e8 commit be58fed

File tree

11 files changed

+4871
-21
lines changed

11 files changed

+4871
-21
lines changed

‎.gitignore‎

Lines changed: 151 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,156 @@
1-
# Compiled source #
2-
###################
3-
*.com
4-
*.class
5-
*.dll
6-
*.exe
7-
*.o
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
87
*.so
98

10-
# Packages #
11-
############
12-
# it's better to unpack these files and commit the raw source
13-
# git has its own built in compression methods
14-
*.gz
15-
*.iso
16-
*.jar
17-
*.tar
18-
*.zip
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
19154

20155
# Logs and databases #
21156
######################
@@ -33,8 +168,3 @@
33168
.Trashes
34169
ehthumbs.db
35170
Thumbs.db
36-
37-
# Additional files #
38-
####################
39-
*.rst
40-
README.org

‎docs/api.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
***
2+
API
3+
***
4+
5+
.. toctree::
6+
7+
api/main
8+
api/plotting
9+
api/dev_metrics
10+
api/oob_metrics

‎docs/api/dev_metrics.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
***
2+
Developmental set metrics functions
3+
***
4+
.. currentmodule:: dRFEtools
5+
6+
.. autosummary::
7+
8+
dev_score_accuracy
9+
dev_score_evar
10+
dev_score_mse
11+
dev_score_nmi
12+
dev_score_r2
13+
dev_score_roc

‎docs/api/main.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
***
2+
Main functions
3+
***
4+
.. currentmodule:: dRFEtools
5+
6+
.. autosummary::
7+
8+
rf_rfe
9+
dev_rfe
10+
features_rank_fnc
11+
extract_max_lowess
12+
extract_peripheral_lowess

‎docs/api/oob_metrics.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
***
2+
Out-of-Bag (OOB) metrics functions
3+
***
4+
.. currentmodule:: dRFEtools
5+
6+
.. autosummary::
7+
8+
oob_score_accuracy
9+
oob_score_evar
10+
oob_score_mse
11+
oob_score_nmi
12+
oob_score_r2
13+
oob_score_roc

‎docs/api/plotting.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
***
2+
Plotting functions
3+
***
4+
.. currentmodule:: dRFEtools
5+
6+
.. autosummary::
7+
8+
optimize_lowess_plot
9+
plot_metric
10+
plot_with_lowess_vline

‎docs/index.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. dRFEtools documentation master file, created by
2+
sphinx-quickstart on Fri Jul 12 22:21:28 2024.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to dRFEtools's documentation!
7+
=====================================
8+
9+
`dRFEtools` is a package for dynamic recursive feature elimination with
10+
scikit-learn.
11+
12+
.. toctree::
13+
:maxdepth: 2
14+
:caption: Contents:
15+
16+
install
17+
tutorials
18+
api
19+
20+
Indices and tables
21+
==================
22+
23+
* :ref:`genindex`
24+
* :ref:`modindex`
25+
* :ref:`search`

‎docs/install.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
*******
2+
Install
3+
*******
4+
5+
It can be installed via pip::
6+
7+
pip install dRFEtools

‎docs/tutorials.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
***
2+
Tutorials
3+
***
4+
5+
.. autosummary::
6+
:toctree: tutorials/
7+
8+
optimization
9+
classification

0 commit comments

Comments
 (0)