WIP documentation generation via gh actions (facebookresearch#107)

Summary: Pull Request resolved: facebookresearch#107 Differential Revision: D67157339
dkorenkevych · Dec 12, 2024 · bb375e0 · bb375e0
1 parent c9576ed
commit bb375e0
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -8,18 +8,22 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
     env:
       OS: ${{ matrix.os }}
-      PYTHON: '3.9'
+      PYTHON: '3.10'
     steps:
     - uses: actions/checkout@v4
     - name: Setup Python
       uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: 3.10
     - name: Install dependencies
       run: |
+          pip install pdoc3
           pip install pytest
           pip install pytest-cov
           pip install -e .
+    - name: Update documentation
+      run: |
+        pdoc -o ./html pearl
     - name: Generate coverage report
       run: |
         pytest --cov=./ --cov-report=xml

diff --git a/pearl/api/action_result.py b/pearl/api/action_result.py
@@ -23,9 +23,9 @@ class ActionResult:
     reward: Reward
     terminated: bool
     truncated: bool
-    info: dict[str, Any] | None = None
-    cost: float | None = None
-    available_action_space: ActionSpace | None = None
+    info: Optional[dict[str, Any]] = None
+    cost: Optional[float] = None
+    available_action_space: Optional[ActionSpace] = None
 
     @property
     def done(self) -> bool:

diff --git a/pearl/history_summarization_modules/history_summarization_module.py b/pearl/history_summarization_modules/history_summarization_module.py
@@ -26,7 +26,7 @@ class HistorySummarizationModule(ABC, nn.Module):
 
     @abstractmethod
     def summarize_history(
-        self, observation: Observation, action: Action | None
+        self, observation: Observation, action: Optional[Action]
     ) -> SubjectiveState:
         pass