Commit 604e98ad authored by Christian Marius Lillelund's avatar Christian Marius Lillelund
Browse files

updated docs

parent e2988755
Commands
========
The Makefile contains the central entry points for common tasks related to this project.
Syncing data to S3
^^^^^^^^^^^^^^^^^^
* `make sync_data_to_s3` will use `aws s3 sync` to recursively sync files in `data/` up to `s3://[OPTIONAL] your-bucket-for-syncing-data (do not include 's3://')/data/`.
* `make sync_data_from_s3` will use `aws s3 sync` to recursively sync files from `s3://[OPTIONAL] your-bucket-for-syncing-data (do not include 's3://')/data/` to `data/`.
Getting started
===============
This is where you describe how to get set up on a clean install, including the
commands necessary to get the raw data (using the `sync_data_from_s3` command,
for example), and then how to make the cleaned, final data sets.
......@@ -34,7 +34,7 @@ Analysis
.. automodule:: analysis.evaluate_balance
:members:
.. automodule:: analysis.evaluate_baseline
.. automodule:: analysis.evaluate_classification_cases
:members:
.. automodule:: analysis.evaluate_gender_bias
......@@ -43,6 +43,9 @@ Analysis
.. automodule:: analysis.evaluate_preprocessing
:members:
.. automodule:: analysis.evaluate_survival_case
:members:
.. automodule:: analysis.find_best_ats_resolution
:members:
......@@ -91,22 +94,16 @@ 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
.. automodule:: model.train_complete_model
:members:
.. automodule:: model.train_xgb_models
.. automodule:: model.train_compliance_model
:members:
Tools
......@@ -145,9 +142,6 @@ Tools
Tuning
------
.. automodule:: tuning.run_all_tune_scripts
:members:
.. automodule:: tuning.tune_alarm_boost_wb
:members:
......@@ -169,6 +163,9 @@ Tuning
Utility
-------
.. automodule:: utility.config
:members:
.. automodule:: utility.data
:members:
......@@ -178,9 +175,6 @@ Utility
.. automodule:: utility.metrics
:members:
.. automodule:: utility.settings
:members:
.. automodule:: utility.time
:members:
......
......@@ -8,13 +8,6 @@ Usage
The documentation is accessible through Swagger at http://127.0.0.1:8000/docs when hosted locally.
In order to deploy the ML API to Azure, please first build the Docker image and then push it to our container registry on Azure. At Azure we run an App Service that will automatically fetch the latest image and deploy it. The following Powershell commands can be used to first authenticate to Azure, connect to the registry, build the image and then push:
$ Connect-AzAccount
$ Connect-AzContainerRegistry -Name aircontainerregistry
$ docker build -t aircontainerregistry.azurecr.io/airapi .
$ docker push aircontainerregistry.azurecr.io/airapi
Contact
==============================
......
"""
run_all_tune_scripts.py
====================================
Utility module that runs all tune scripts.
"""
from tuning import (tune_alarm_boost_wb,
tune_alarm_rsf_wb,
tune_complete_rf_wb,
tune_complete_xgb_wb,
tune_compliance_rf_wb,
tune_compliance_xgb_wb)
def main():
tune_alarm_boost_wb.main()
tune_alarm_rsf_wb.main()
tune_complete_rf_wb.main()
tune_complete_xgb_wb.main()
tune_compliance_rf_wb.main()
tune_compliance_xgb_wb.main()
if __name__ == "__main__":
main()
"""
tune_alarm_boost_wb.py
====================================
Grad. boost tune script for Alarm case on WanDB.
Gradient boosting tune script for Alarm case on WanDB.
"""
from sksurv.ensemble import GradientBoostingSurvivalAnalysis
......
"""
tune_alarm_rsf_wb.py
====================================
Random survival forest tune script for Alarm case on WanDB.
Random Survival Forest tune script for Alarm case on WanDB.
"""
from utility.config import load_config
......
"""
tune_complete_xgb_wb.py
====================================
Xgboost tune script for Complete case on WanDB.
XGBoost tune script for Complete case on WanDB.
"""
from utility.config import load_config
......
"""
tune_compliance_xgb_wb.py
====================================
Xgboost tune script for Compliance case on WanDB.
XGBoost tune script for Compliance case on WanDB.
"""
from utility.config import load_config
......
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