titli 0.0.10

A library for collection of IDS and tools for evaluating them

Titli

A toolkit for hosting feature extraction, model training, model inference, and model evaluation of AI-based Intrusion Detection Systems

Documentation

📚 Read the full documentation to get started with Titli.

The documentation includes:

• Installation guide
• Quick start tutorial
• Detailed usage examples
• Complete API reference
• And more!

To build the documentation locally:

cd docs
pip install sphinx sphinx-rtd-theme sphinx-autodoc-typehints
make html

Then open docs/build/html/index.html in your web browser.

Installation

pip install titli

Usage

• Step 1: Copy the examples/train_ids.py and examples/test_ids.py file from the repo to your local machine.
• Step 2: Run both the files to train and test the Kitsune IDS respectively.

Todo (Developer Tasks)

• Check if RMSE is used for loss or just the difference.
• Put Kitsune code into the base IDS format.
• Write code to evaluate the model and calculate all the metrics.

TODO New:

• Resolve BaseSKLearn class infer function's TODO

• Make fit and predict function as private by putting "_" in the starting

• Similar to PyTorch, define call function for SkLearn models too

• Write where the model is saved in the print statement!