User Stories
============

This section contains real-world user stories demonstrating how SACRO-ML is used in Trusted Research Environments (TREs).

User Story 1: Basic Model Training and Attack
----------------------------------------------

A basic workflow showing model training and privacy assessment.

**Researcher Template:**

.. literalinclude:: ../../examples/user_stories/user_story_1/user_story_1_researcher_template.py
   :language: python
   :linenos:
   :caption: User Story 1 - Researcher Template

**TRE Implementation:**

.. literalinclude:: ../../examples/user_stories/user_story_1/user_story_1_tre.py
   :language: python
   :linenos:
   :caption: User Story 1 - TRE Implementation

User Story 2: Data Processing and Privacy Assessment
-----------------------------------------------------

Advanced workflow including data preprocessing and comprehensive privacy assessment.

**Data Processing:**

.. literalinclude:: ../../examples/user_stories/user_story_2/data_processing_researcher.py
   :language: python
   :linenos:
   :caption: User Story 2 - Data Processing

**Researcher Template:**

.. literalinclude:: ../../examples/user_stories/user_story_2/user_story_2_researcher_template.py
   :language: python
   :linenos:
   :caption: User Story 2 - Researcher Template

**TRE Implementation:**

.. literalinclude:: ../../examples/user_stories/user_story_2/user_story_2_tre.py
   :language: python
   :linenos:
   :caption: User Story 2 - TRE Implementation

User Story 3: Advanced Privacy Analysis
----------------------------------------

Comprehensive privacy analysis workflow for sensitive datasets.

**Researcher Template:**

.. literalinclude:: ../../examples/user_stories/user_story_3/user_story_3_researcher_template.py
   :language: python
   :linenos:
   :caption: User Story 3 - Researcher Template

**TRE Implementation:**

.. literalinclude:: ../../examples/user_stories/user_story_3/user_story_3_tre.py
   :language: python
   :linenos:
   :caption: User Story 3 - TRE Implementation

Configuration and Utilities
----------------------------

**Default Configuration:**

.. literalinclude:: ../../examples/user_stories/default_config.yaml
   :language: yaml
   :linenos:
   :caption: Default Configuration File

**Report Generation:**

.. literalinclude:: ../../examples/user_stories/generate_disclosure_risk_report.py
   :language: python
   :linenos:
   :caption: Disclosure Risk Report Generation