Skip to main content

Attack recovery support system using an LLM

Project description

Decision-Theoretic Incident Response Planning with a Lightweight Large Language Model

A decision-support system powered by a foundation model for recovering from cyberattacks in networked systems.

Requirements

  • Python 3.8+
  • torch
  • transformers
  • peft
  • bitsandbytes
  • accelerate

Development Requirements

  • Python 3.8+
  • flake8 (for linting)
  • flake8-rst-docstrings (for linting docstrings)
  • tox (for automated testing)
  • pytest (for unit tests)
  • pytest-cov (for unit test coverage)
  • mypy (for static typing)
  • mypy-extensions (for static typing)
  • mypy-protobuf (for static typing)
  • types-PyYaml (for static typing)
  • types-paramiko (for static typing)
  • types-protobuf (for static typing)
  • types-requests (for static typing)
  • types-urllib3 (for static typing)
  • sphinx (for API documentation)
  • sphinxcontrib-napoleon (for API documentation)
  • sphinx-rtd-theme (for API documentation)
  • pytest-mock (for mocking tests)
  • pytest-grpc (for grpc tests)

Installation

# install from pip
pip install llm_recovery==<version>
# local install from source
$ pip install -e llm_recovery
# or (equivalently):
make install
# force upgrade deps
$ pip install -e llm_recovery --upgrade
# git clone and install from source
git clone https://github.com/Limmen/llm_recovery
cd llm_recovery
pip3 install -e .
# Install development dependencies
$ pip install -r requirements_dev.txt

Development tools

Install all development tools at once:

make install_dev

or

pip install -r requirements_dev.txt

Static code analysis

To run the Python linter, execute the following command:

flake8 .
# or (equivalently):
make lint

To run the mypy type checker, execute the following command:

mypy .
# or (equivalently):
make types

Unit tests

To run all the unit tests, execute the following command:

pytest
# or (equivalently):
make unit_tests

To run tests of a specific test suite, execute the following command:

pytest -k "ClassName"

To generate a coverage report, execute the following command:

pytest --cov=llm_recovery

Run tests and code analysis in different python environments

To run tests and code analysis in different python environments, execute the following command:

tox
# or (equivalently):
make tests

Create a new release and publish to PyPi

First build the package by executing:

python -m build
# or (equivalently)
make build

After running the command above, the built package is available at ./dist.

Push the built package to PyPi by running:

python -m twine upload dist/*
# or (equivalently)
make push

To run all commands for the release at once, execute:

make release

Author & Maintainer

Kim Hammar kimham@kth.se

Copyright and license

LICENSE

Creative Commons

(C) 2025, Kim Hammar

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llm_recovery-0.0.11.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llm_recovery-0.0.11-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file llm_recovery-0.0.11.tar.gz.

File metadata

  • Download URL: llm_recovery-0.0.11.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for llm_recovery-0.0.11.tar.gz
Algorithm Hash digest
SHA256 8e6bce2faf17f97b2b44268068ebd99c089aa5209348a17bf1adf6eaceeb38e9
MD5 841752b7716cb99da2152e6803c9e079
BLAKE2b-256 4e31419ac5a7535df1c904ef0c9dcd2aa37e9a34624b721d54a4975c2f93119c

See more details on using hashes here.

File details

Details for the file llm_recovery-0.0.11-py3-none-any.whl.

File metadata

  • Download URL: llm_recovery-0.0.11-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for llm_recovery-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 0ffd083fdd2580b59d64b8e475a8210ccdf4843744a86f3a16bddaec65c89cd7
MD5 5ac338c372d12b2d0269e021f222b495
BLAKE2b-256 7bd768579af18b11de3dceb98664c8a01944d42f803666645f0fcb455dd0c381

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page