Add references to RxInferServer and Python SDK (#459)

* add references to python client

* update benchmark figures

* fix tests

* update format check CI job

* 🤖 Auto-format Julia code

* update version to 4.4.1

* 2prev

---------

Co-authored-by: bvdmitri <6557701+bvdmitri@users.noreply.github.com>

Author: bvdmitri

.github/workflows/CI.yml

@@ -40,11 +40,6 @@ jobs:
           # PDF. Note, this should be the same directory as the input
           # paper.md
           path: paper/paper.pdf
-  code-style:
-    name: Code Style Suggestions
-    runs-on: ubuntu-latest
-    steps:
-      - uses: julia-actions/julia-format@v3
   test:
     name: Tests ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
@@ -120,4 +115,169 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           LOG_USING_RXINFER: "false"
+  format-check:
+    name: Code Format Check
+    runs-on: ubuntu-latest
+    # Don't run on PRs that come from forks as they won't have permission to create PRs
+    if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
+    permissions:
+      contents: write    # Needed to push commits
+      pull-requests: write  # Needed to create PRs and write comments
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: julia-actions/setup-julia@v2
+      - uses: julia-actions/cache@v2
+      
+      # Find existing format PR if any
+      - name: Find existing format PR
+        id: find_pr
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const prNumber = ${{ github.event.pull_request.number }};
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            
+            // Look for open PRs with our auto-format branch pattern that targets this PR's branch
+            const prs = await github.rest.pulls.list({
+              owner,
+              repo,
+              state: 'open',
+              base: '${{ github.head_ref }}'
+            });
+            
+            const formatPr = prs.data.find(pr => pr.head.ref.startsWith('auto-format-') && 
+                                             pr.title === "🤖 Auto-format Julia code");
+            
+            if (formatPr) {
+              console.log(`Found existing format PR: #${formatPr.number}`);
+              return formatPr.number;
+            }
+            
+            return '';
+      
+      - name: Run formatter check
+        id: format_check
+        run: |
+          if ! make lint; then
+            echo "format_needs_fix=true" >> $GITHUB_OUTPUT
+          else
+            echo "format_needs_fix=false" >> $GITHUB_OUTPUT
+          fi
+      
+      # Close any existing formatting PR if the check now passes
+      - name: Close existing format PR if check passes
+        if: steps.format_check.outputs.format_needs_fix == 'false' && steps.find_pr.outputs.result != ''
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const formatPrNumber = Number(${{ steps.find_pr.outputs.result }});
+
+            if (formatPrNumber === 0) {
+              return;
+            }
+
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            
+            // Close the PR with a comment
+            await github.rest.issues.createComment({
+              owner,
+              repo,
+              issue_number: formatPrNumber,
+              body: `Closing this PR as the code formatting issues in the original PR have been resolved.`
+            });
+            
+            await github.rest.pulls.update({
+              owner,
+              repo,
+              pull_number: formatPrNumber,
+              state: 'closed'
+            });
+            
+            console.log(`Closed format PR #${formatPrNumber} as the original PR now passes formatting checks.`);
+      
+      - name: Apply formatter if needed
+        if: steps.format_check.outputs.format_needs_fix == 'true'
+        run: |
+          make format
+      
+      - name: Commit changes and create/update PR
+        if: steps.format_check.outputs.format_needs_fix == 'true'
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "🤖 Auto-format Julia code"
+          title: "🤖 Auto-format Julia code"
+          body: |
+            This PR was automatically created to fix Julia code formatting issues.
+            
+            The formatting was applied using JuliaFormatter according to the project's style guidelines.
+            
+            Please review the changes and merge if appropriate.
+          branch: auto-format-${{ github.event.pull_request.number }}
+          base: ${{ github.head_ref }}
+          delete-branch: true
+          labels: |
+            automated pr
+            code style
+        id: create-pr
+      
+      - name: Comment on original PR
+        if: steps.format_check.outputs.format_needs_fix == 'true' && steps.create-pr.outputs.pull-request-number && steps.find_pr.outputs.result == ''
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const prNumber = ${{ github.event.pull_request.number }};
+            const formatPrNumber = ${{ steps.create-pr.outputs.pull-request-number }};
+            const formatPrUrl = `https://github.com/${{ github.repository }}/pull/${formatPrNumber}`;
+            
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: prNumber,
+              body: `## 🤖 Code Formatting
+              
+              This PR has some code formatting issues. I've created [PR #${formatPrNumber}](${formatPrUrl}) with the necessary formatting changes.
+              
+              You can merge that PR into this branch to fix the code style check.
+              
+              Alternatively, you can run \`make format\` locally and push the changes yourself.`
+            });
+      
+      - name: Comment on original PR for updated formatting PR
+        if: steps.format_check.outputs.format_needs_fix == 'true' && steps.create-pr.outputs.pull-request-number && steps.find_pr.outputs.result != ''
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const prNumber = ${{ github.event.pull_request.number }};
+            const formatPrNumber = ${{ steps.create-pr.outputs.pull-request-number }};
+            const formatPrUrl = `https://github.com/${{ github.repository }}/pull/${formatPrNumber}`;
+            
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: prNumber,
+              body: `## 🤖 Code Formatting
+              
+              Your PR still has some code formatting issues. I've updated [PR #${formatPrNumber}](${formatPrUrl}) with the necessary formatting changes.
+              
+              You can merge that PR into this branch to fix the code style check.
+              
+              Alternatively, you can run \`make format\` locally and push the changes yourself.`
+            });
+      
+      # Fail the job if formatting was needed and applied
+      - name: Fail if formatting was needed
+        if: steps.format_check.outputs.format_needs_fix == 'true'
+        run: |
+          echo "::error::Code formatting issues detected. A PR with fixes has been created, but this check is failing to indicate that formatting needs to be fixed."
+          exit 1
       

Project.toml

@@ -1,7 +1,7 @@
 name = "RxInfer"
 uuid = "86711068-29c9-4ff7-b620-ae75d7495b3d"
 authors = ["Bagaev Dmitry <d.v.bagaev@tue.nl> and contributors"]
-version = "4.4.0"
+version = "4.4.1"
 
 [deps]
 BayesBase = "b4ee3484-f114-42fe-b91c-797d54a0c67e"

README.md

@@ -19,6 +19,9 @@
 
 Given a probabilistic model, RxInfer allows for an efficient message-passing based Bayesian inference. It uses the model structure to generate an algorithm that consists of a sequence of local computations on a factor graph representation of the model.
 
+> [!NOTE]
+> RxInfer can also be used from Python through our [client-server infrastructure](#client-server-infrastructure) and [Python SDK](https://github.com/lazydynamics/RxInferClient.py).
+
 ### Performance and scalability
 
 RxInfer.jl has been designed with a focus on efficiency, scalability and maximum performance for running Bayesian inference with message passing. Below is a comparison between RxInfer.jl and Turing.jl on latent state estimation in a linear multi-variate Gaussian state-space model. [Turing.jl](https://github.com/TuringLang/Turing.jl) is a state-of-the-art Julia-based general-purpose probabilistic programming package and is capable of running inference in a broader class of models. Still, RxInfer.jl executes the inference task in [various models](https://examples.rxinfer.com) faster and more accurately. RxInfer.jl accomplishes this by taking advantage of any conjugate likelihood-prior pairings in the model, which have analytical posteriors that are known by RxInfer.jl. As a result, in models with conjugate pairings, RxInfer.jl often beats general-purpose probabilistic programming packages in terms of computational load, speed, memory and accuracy. Note, however, that RxInfer.jl also supports non-conjugate inference and is continually improving in order to support a larger class of models.
@@ -179,6 +182,29 @@ The `RxInfer` framework consists of four *core* packages developed by [ReactiveB
 - [`ExponentialFamily.jl`](https://github.com/reactivebayes/ExponentialFamily.jl) - package for exponential family distributions
 - [`Rocket.jl`](https://github.com/reactivebayes/Rocket.jl) - reactive extensions package for Julia 
 
+## Client-Server Infrastructure
+
+RxInfer can be deployed as a RESTful API service using [`RxInferServer.jl`](https://github.com/lazydynamics/RxInferServer), which provides:
+
+- OpenAPI-compliant RESTful API endpoints for RxInfer models
+- Support for model instance management and inference execution
+- Real-time inference capabilities
+- Comprehensive API documentation at [server.rxinfer.com](https://server.rxinfer.com)
+
+### Client SDKs
+
+To interact with RxInferServer, you can use one of the following SDKs:
+
+- **Python SDK**: [`RxInferClient.py`](https://github.com/lazydynamics/RxInferClient.py) - A Python client for interacting with RxInferServer
+- **Julia SDK**: Included in the RxInferServer repository
+
+Both SDKs provide a convenient interface to:
+- Create and manage model instances
+- Execute inference tasks
+- Monitor inference progress
+- Handle authentication and API keys
+- Process results in a native format
+
 # Where to go next?
 
 There are a set of [examples](https://examples.rxinfer.com/) available in the `RxInferExamples.jl` repository that demonstrate the more advanced features of the package. Alternatively, you can head to the [documentation](https://docs.rxinfer.com) that provides more detailed information of how to use `RxInfer` to specify more complex probabilistic models.