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.9.tar.gz (25.8 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.9-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: llm_recovery-0.0.9.tar.gz
  • Upload date:
  • Size: 25.8 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.9.tar.gz
Algorithm Hash digest
SHA256 a523aa0721ee1201295b4d41c3a9501a606572278829c0a8bae21d3ceb3d1b17
MD5 c75ec89f755cba82e9cac564f8b43cc4
BLAKE2b-256 2ca65e1b8ade36fba49abd345322fafd35e6bcc63149235694564fb8653a1b71

See more details on using hashes here.

File details

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

File metadata

  • Download URL: llm_recovery-0.0.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 a3084a9f42bc179127a28934b8c890ee08400d5284b7630dbf90d3a8201d9258
MD5 d4f7e9721a2a53087dda9ba3a03a7ddf
BLAKE2b-256 9ad5727ec605ba9a41b9acc216a1ee762bdd1e64c3644df6ad2aaeba8db75bad

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