Commit 986d26bc authored by Christian Marius Lillelund's avatar Christian Marius Lillelund
Browse files

updated docs

parent f69bba75
"""
client.py
====================================
A command line application that can create various datasets.
"""
import argparse
import paths as pt
from src.data import parse_and_clean_data, make_screenings
......
......@@ -235,7 +235,7 @@ man_pages = [
texinfo_documents = [
('index', 'air', u'air Documentation',
u"cfp", 'air',
'AIR is an open-source machine-learning project to model and find patterns in health care data.', 'Miscellaneous'),
'AIR is an open-source machine learning project to improve rehabilitation.', 'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
......
air
=======================================================
.. _index:
****************************************
AIR documentation
****************************************
.. meta::
:description: This is AIR code documentation that describes the source code and useful scripts.
:keywords: Documentation
.. _air-introduction:
Introduction
============
This document is aimed at authors of, developers and contributors to the AIR project.
The source code of AIR is located in its `project repository on GitLab <https://gitlab.au.dk/cfp/air>`_.
For more information, please visit `our official website <https://projekter.au.dk/air/>`_.
.. _air-source-code-documentation:
Source Code Documentation
=========================
This chapter describes all Python modules in the AIR source code.
.. _air-source-code-documentation-analysis:
Analysis
--------
.. automodule:: analysis.evaluate_balance
:members:
.. automodule:: analysis.evaluate_baseline
:members:
.. automodule:: analysis.evaluate_gender_bias
:members:
.. automodule:: analysis.evaluate_preprocessing
:members:
.. automodule:: analysis.find_best_ats_resolution
:members:
.. automodule:: analysis.find_best_features
:members:
API
---
.. automodule:: api.bearer
:members:
.. automodule:: api.main
:members:
Data
----
.. automodule:: data.load_and_clean_data
:members:
.. automodule:: data.make_alarm_data
:members:
.. automodule:: data.make_dataset_count
:members:
.. automodule:: data.make_dataset_emb
:members:
.. automodule:: data.make_dataset_full
:members:
.. automodule:: data.make_dataset_ohe
:members:
.. automodule:: data.make_dataset_ordinal
:members:
.. automodule:: data.make_screening_data
:members:
Db
----
.. automodule:: db.insert_data_into_db
:members:
Demo
----
.. automodule:: demo.who_completes
:members:
Model
-----
.. automodule:: model.train_alarm_model
:members:
.. automodule:: model.train_rf_models
:members:
.. automodule:: model.train_xgb_models
:members:
Tools
-----
.. automodule:: tools.classifiers
:members:
.. automodule:: tools.cleaner
:members:
.. automodule:: tools.data_loader
:members:
.. automodule:: tools.file_reader
:members:
.. automodule:: tools.file_writer
:members:
.. automodule:: tools.inputter
:members:
.. automodule:: tools.labeler
:members:
.. automodule:: tools.neural_embedder
:members:
.. automodule:: tools.preprocessor
:members:
.. automodule:: tools.raw_loader
:members:
Tuning
------
.. automodule:: tuning.run_all_tune_scripts
:members:
.. automodule:: tuning.tune_alarm_boost_wb
:members:
.. automodule:: tuning.tune_alarm_rsf_wb
:members:
.. automodule:: tuning.tune_complete_rf_wb
:members:
.. automodule:: tuning.tune_complete_xgb_wb
:members:
.. automodule:: tuning.tune_compliance_rf_wb
:members:
.. toctree::
:maxdepth: 2
:caption: Contents:
.. automodule:: tuning.tune_compliance_xgb_wb
:members:
Utility
-------
.. automodule:: utility.data
:members:
.. automodule:: utility.embedder
:members:
.. automodule:: utility.metrics
:members:
.. automodule:: utility.settings
:members:
.. automodule:: utility.time
:members:
Indices and tables
==================
......
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
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% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
......@@ -7,7 +7,7 @@ setup(
setup_requires=["pytest-runner"],
tests_require=["pytest"],
version='0.0.1',
description='AIR is an open-source ML project to improve rehabilitation.',
description='AIR is an open-source machine learning project to improve rehabilitation.',
author='Christian Marius Lillelund',
author_email='cl@ece.au.dk',
license='MIT',
......
"""
evaluate_balance.py
====================================
Script to evaluate the performance of using class weights
Script to evaluate the performance of using class weights.
"""
from tools import data_loader
......
......@@ -2,7 +2,7 @@
evaluate_baseline.py
====================================
Script to make a baseline evaluation of cases
using CV with different datasets and classifers
using CV with different datasets and classifers.
"""
import numpy as np
......
"""
evaluate_gender_bias.py
====================================
Script to evaluate gender bias in the Fall case
Script to evaluate gender bias in the Fall case.
"""
from pathlib import Path
......
"""
evaluate_preprocessing.py
====================================
Script to evaluate preprocessing strategies for cases
Script to evaluate preprocessing strategies for cases.
"""
import numpy as np
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment