version 1.3.5 (#56)

* dev version

* adding DictState

* run ci on dev-latest branch

* DictState doesn't need objclass

* allow Agent and Environment to be created without all models

* policy model can be optional upon init for Agent

* add test for setting model for agent

* test agent env set model

* black

* option function names noun to verb

* oops word correction

* hashable frozen weighted particles

* add the frozen property

* remove spurious argument

* refactor pouct _search to be easier for overriding

* black

* comment correction

* type fix. time.time returns a double

* remove spurious argument for pomcp

* additional attributes

* det_dict_hash without sorting

* add frozen

* one more attr

* rollout policy should default to none

* one more property

* pbar

* adding release script

* Update scripts/README.md - remove image

* include pomdp-solve in manifest

* properly deal with build version while on dev-latest

* script doesn't need an argument

* include pomdp-solve binary when building pomdp-py

* version should match convention

* regenerate manifest

* do not build thirdparty binary into wheel

* restore setup.py

* build wheel workflow

* typo fix

* workflow fix

* release script no arg

* print current branch for debugging

* fix typo

* non interactive and non sudo for github action friendly

* no sudo chown

* testing wheel release with action-gh-release

* trigger for wheel build should be tag

* release name in workflow

* be real now - workflow works!

* rocksample minor refactor for importability

* make half_efficiency_dist tunable in rocksample

* add py3.12 to matrix for package ci

* attempt count for more robust twine pypi push

* pypi deployment workflow attempt

* oops

* remove unneeded

* forgot id-token

* try test pypi token; skip pip install ask

* verbose

* dramatic test

* comment out all secrets for now

* use variable

* vars

* revert; now we may be ready

* attempt count shows up later

* fix attempt name

* fix fix

* one more attempt

* this should do it?

* oops, wrong place

* ok good now. only run the deployment action when tagging

* release artifact at the end

* workflow syntax fix

* simplify

* fix

* release art

* remove unnecessary readme file

* changelog rst

* black

---------

Co-authored-by: Kaiyu Zheng <[email protected]>

.github/workflows/build_wheel.yml

@@ -0,0 +1,45 @@
+name: pomdp-py build dev-latest wheel
+
+on:
+  push:
+    tags:
+      - 'vdev-latest'  # trigger on the tag vdev-latest
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+    steps:
+
+    - name: Set release name with date
+      id: set_release_name
+      run: echo "RELEASE_NAME=pomdp-py (dev-latest $(date +'%Y-%m-%d'))" >> $GITHUB_ENV
+
+    - uses: actions/checkout@v4
+      with:
+        ref: 'dev-latest'
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+
+    - name: Run release script
+      working-directory: .
+      run: |
+        cd scripts
+        ./pomdp_py_release.sh
+
+    - name: Release artifact
+      uses: softprops/action-gh-release@v1
+      with:
+        name: ${{ env.RELEASE_NAME }}
+        files: dist/*.whl

.github/workflows/macos.yml

@@ -2,9 +2,9 @@ name: pomdp-py repo macOS build
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, dev-latest ]
   pull_request:
-    branches: [ main ]
+    branches: [ main, dev-latest ]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

.github/workflows/pre_commit.yml

@@ -7,7 +7,7 @@ on:
   pull_request:
     branches:
       - main
-
+      - dev-latest
 jobs:
   pre-commit:
     runs-on: ubuntu-latest

.github/workflows/pypi_deployment.yml

@@ -0,0 +1,74 @@
+name: pomdp-py package pypi deployment
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pypi-publish:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/pomdp-py/
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+    - name: Set Variables
+      if: startsWith(github.ref, 'refs/tags/v')
+      run: |   # Run the command within a multiline string
+          echo "VERSION=\"Version ${{ github.ref_name }}\"" >> $GITHUB_ENV
+          echo "TRIGGER_FOR_TEST_PYPI=${{ github.ref == 'refs/tags/vdev-latest' }}" >> $GITHUB_ENV
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - uses: actions/checkout@v4
+      with:
+        ref: 'dev-latest'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+
+    - name: Run release script
+      working-directory: .
+      run: |
+        cd scripts
+        ./pomdp_py_release.sh ${{ vars.RELEASE_ATTEMPT_COUNT }}
+
+    - name: Upload to Test PyPi
+      uses: pypa/gh-action-pypi-publish@release/v1
+      if: ${{ env.TRIGGER_FOR_TEST_PYPI }}
+      with:
+        # This will upload stuff under dist/ to PyPI
+        user: __token__
+        password: ${{ secrets.TEST_PYPI_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+        skip-existing: true
+
+    - name: Upload to PyPi
+      uses: pypa/gh-action-pypi-publish@release/v1
+      if: ${{ ! env.TRIGGER_FOR_TEST_PYPI }}
+      with:
+        # This will upload stuff under dist/ to PyPI
+        user: __token__
+        password: ${{ secrets.PYPI_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+        skip-existing: true
+
+    - name: Release artifact
+      uses: softprops/action-gh-release@v1
+      with:
+        name: ${{ env.VERSION }}
+        files: dist/*.whl

.github/workflows/python-package.yml

@@ -5,9 +5,9 @@ name: pomdp-py package
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "dev-latest" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "dev-latest" ]
 
 jobs:
   build:
@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v3

.github/workflows/ubuntu.yml

@@ -2,9 +2,9 @@ name: pomdp-py repo ubuntu build
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, dev-latest ]
   pull_request:
-    branches: [ main ]
+    branches: [ main, dev-latest ]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

CHANGELOG.rst

@@ -3,6 +3,32 @@ Changelog
 
 Best viewed on `the website <https://h2r.github.io/pomdp-py/html/changelog.html>`_.
 
+Version 1.3.5 (03/12/2024)
+--------------------------
+* Refactored :code:`_search` in :py:mod:`~pomdp_py.algorithms.po_uct.POUCT` to be more modular
+* More fields made accessible for :py:mod:`~pomdp_py.algorithms.po_uct.POUCT`
+* Allows initializing :py:mod:`~pomdp_py.framework.basics.Agent` and :py:mod:`~pomdp_py.framework.basics.Environment` without all models ready, and provide those models later (or update them) by :code:`set_models`
+* Minor function renaming for :py:mod:`~pomdp_py.framework.basics.Option`
+* Added :py:mod:`~pomdp_py.framework.oopomdp.DictState`
+* Improved modularity and documentation for the RockSample example
+* :py:mod:`~pomdp_py.representations.distribution.particles.WeightedParticles` now hashable if frozen.
+* Changed :code:`det_dict_hash` to not use sorting
+* Added a GHA workflow  for automatically building, releasing wheels and uploading them to PyPI
+* Repo convention: default branch renamed from :code:`master` to :code:`main`, and :code:`dev-latest` is the development branch.
+
+
+WeightedParticles now hashable if frozen
+Refactor _search in POUCT for more modularity
+added a workflow that builds wheel
+*
+
+Modernize repo without introducing new features.
+* Migrate to :code:`pyproject.toml` to specify dependencies, with minimal :code:`setup.py` to build Cython extensions.
+* Separate core and optional dependencies. Optional dependencies are needed only for `pomdp_py.problems`.
+* Added CI testing to repo.
+* Added pre-commit checks to repo.
+
+
 Version 1.3.4 (01/26/2024)
 --------------------------
 * Modernize repo without introducing new features.

MANIFEST.in

@@ -1,26 +1,27 @@
-include ./pomdp_py/utils/cython_utils.pxd
-include ./pomdp_py/algorithms/po_uct.pxd
-include ./pomdp_py/algorithms/po_rollout.pxd
-include ./pomdp_py/algorithms/pomcp.pxd
-include ./pomdp_py/algorithms/value_iteration.pxd
-include ./pomdp_py/representations/belief/particles.pxd
 include ./pomdp_py/representations/distribution/particles.pxd
-include ./pomdp_py/representations/distribution/gaussian.pxd
 include ./pomdp_py/representations/distribution/histogram.pxd
+include ./pomdp_py/representations/distribution/gaussian.pxd
+include ./pomdp_py/representations/belief/particles.pxd
+include ./pomdp_py/utils/cython_utils.pxd
+include ./pomdp_py/framework/oopomdp.pxd
 include ./pomdp_py/framework/planner.pxd
 include ./pomdp_py/framework/basics.pxd
-include ./pomdp_py/framework/oopomdp.pxd
-include ./pomdp_py/utils/cython_utils.pyx
+include ./pomdp_py/algorithms/po_rollout.pxd
+include ./pomdp_py/algorithms/pomcp.pxd
+include ./pomdp_py/algorithms/po_uct.pxd
+include ./pomdp_py/algorithms/value_iteration.pxd
 include ./pomdp_py/problems/rocksample/cythonize/rocksample_problem.pyx
 include ./pomdp_py/problems/tiger/cythonize/tiger_problem.pyx
-include ./pomdp_py/algorithms/value_iteration.pyx
-include ./pomdp_py/algorithms/pomcp.pyx
-include ./pomdp_py/algorithms/po_rollout.pyx
-include ./pomdp_py/algorithms/po_uct.pyx
-include ./pomdp_py/representations/belief/particles.pyx
-include ./pomdp_py/representations/distribution/particles.pyx
 include ./pomdp_py/representations/distribution/histogram.pyx
 include ./pomdp_py/representations/distribution/gaussian.pyx
-include ./pomdp_py/framework/basics.pyx
+include ./pomdp_py/representations/distribution/particles.pyx
+include ./pomdp_py/representations/belief/particles.pyx
+include ./pomdp_py/utils/cython_utils.pyx
 include ./pomdp_py/framework/planner.pyx
+include ./pomdp_py/framework/basics.pyx
 include ./pomdp_py/framework/oopomdp.pyx
+include ./pomdp_py/algorithms/po_rollout.pyx
+include ./pomdp_py/algorithms/value_iteration.pyx
+include ./pomdp_py/algorithms/pomcp.pyx
+include ./pomdp_py/algorithms/po_uct.pyx
+include ./thirdparty/pomdp-solve/src/pomdp-solve

pomdp_py/algorithms/po_uct.pxd

@@ -32,6 +32,12 @@ cdef class POUCT(Planner):
     cdef int _pbar_update_interval
 
     cpdef _search(self)
+    cdef _initialize_progress_bar(self)
+    cpdef _perform_simulation(self, state)
+    cdef bint _should_stop(self, int sims_count, double start_time)
+    cdef _update_progress(self, pbar, int sims_count, double start_time)
+    cdef _finalize_progress_bar(self, pbar)
+
     cpdef _simulate(POUCT self,
                     State state, tuple history, VNode root, QNode parent,
                     Observation observation, int depth)