Skip to content

TODO.md

Latest commit

 

History

History
47 lines (38 loc) · 2.47 KB

TODO.md

File metadata and controls

47 lines (38 loc) · 2.47 KB

Pgeon Refactoring Plan

This document outlines the plan to refactor the pgeon codebase to improve modularity, type safety, and test coverage.

1. Project Setup

  • Transition to uv for dependency management.
    • Update pyproject.toml for uv compatibility.
    • Generate uv.lock file.
  • Ensure all existing tests pass before refactoring.

2. Code Refactoring and Consolidation

  • Deprecate PolicyGraph (src/pgeon/policy_graph.py).
    • Merge functionality from PolicyGraph into PolicyApproximatorFromBasicObservation.
    • Refactor PolicyGraph users to use PolicyApproximatorFromBasicObservation.
    • Remove src/pgeon/policy_graph.py.
  • Deprecate IntentionIntrospector (src/pgeon/intention_introspector.py).
    • Move intention finding logic into IntentionAwarePolicyGraph or a new dedicated class that uses the new abstractions.
    • Remove src/pgeon/intention_introspector.py.
  • Refactor PolicyApproximator and PolicyRepresentation.
    • Ensure PolicyApproximatorFromBasicObservation correctly and consistently uses a PolicyRepresentation instance.
    • Remove redundant methods between the old PolicyGraph and the new approximators.
  • Refactor ipg_xai.py for better integration.
    • Update IPG_XAI_analyser to use PolicyApproximator and PolicyRepresentation instead of PolicyGraph.
    • Ensure type consistency with the new abstractions.
  • Merge IPG_XAI_analyser into IntentionAwarePolicyApproximator.
    • Move answer_what, answer_how, and answer_why methods from IPG_XAI_analyser to IntentionAwarePolicyApproximator.
    • Delete src/pgeon/ipg_xai.py.
    • Update test/pgeon/test_ipg_xai.py to reflect the changes.

3. Testing

  • Update tests to reflect refactoring.
    • Remove or update tests for deprecated files (test_policy_graph.py, test_intention_introspector.py).
  • Enhance tests for test_policy_approximator.py and test_policy_representation.py.
  • Add new tests to improve coverage.
    • Write unit tests for new or modified functionality.
    • Implement end-to-end tests using the cartpole environment.
  • Refactor and restructure test_intention_aware_policy_graph.py
  • Add granular tests for IntentionAwarePolicyApproximator methods
  • Enhance existing answer_* tests for more complex scenarios

4. Finalization

  • Code cleanup and final review.
  • Merge the refactor/codebase-cleanup branch into main.