Deprecate and Migrate TuringCallbacks

.github/workflows/Documentation.yml

@@ -28,6 +28,8 @@ jobs:
         pkg:
           - name: TuringBenchmarking
             dir: './TuringBenchmarking'
+          - name: TuringCallbacks
+            dir: './TuringCallbacks'
 
     steps:
       - name: Build and deploy

TuringCallbacks/.github/workflows/CompatHelper.yml

@@ -0,0 +1,16 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'

TuringCallbacks/.github/workflows/Docs.yml

@@ -0,0 +1,32 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Build and deploy Documenter.jl docs
+        uses: TuringLang/actions/DocsDocumenter@main
+
+      - run: |
+          julia --project=docs -e '
+            using Documenter: doctest
+            using TuringCallbacks
+            doctest(TuringCallbacks)'

TuringCallbacks/.github/workflows/DocsNav.yml

@@ -0,0 +1,39 @@
+name: Rebuild docs with newest navbar
+
+on:
+  # 3:25 AM UTC every Sunday -- choose an uncommon time to avoid
+  # periods of heavy GitHub Actions usage
+  schedule:
+    - cron: '25 3 * * 0'
+  # Whenever needed
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  update-navbar:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+
+      - name: Insert navbar
+        uses: TuringLang/actions/DocsNav@main
+        with:
+          doc-path: '.'
+
+      - name: Commit and push changes
+        run: |
+          if [[ -n $(git status -s) ]]; then
+            git config user.name github-actions[bot]
+            git config user.email github-actions[bot]@users.noreply.github.com
+            git add -A
+            git commit -m "Update navbar (automated)"
+            git push
+          else
+            echo "No changes to commit"
+          fi

TuringCallbacks/.github/workflows/TagBot.yml

@@ -0,0 +1,15 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}

TuringCallbacks/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
+# Cancel existing tests on the same PR if a new commit is added to a pull request
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: "1"
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v5
+        with:
+          files: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true

TuringCallbacks/.gitignore

@@ -0,0 +1,5 @@
+*.jl.*.cov
+*.jl.cov
+*.jl.mem
+/docs/build/
+Manifest.toml

TuringCallbacks/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Tor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

TuringCallbacks/Project.toml

@@ -0,0 +1,34 @@
+name = "TuringCallbacks"
+uuid = "ea0860ee-d0ef-45ef-82e6-cc37d6be2f9c"
+version = "0.4.4"
+authors = ["Tor Erlend Fjelde <tor.erlend95@gmail.com> and contributors"]
+
+[deps]
+DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
+OnlineStats = "a15396b6-48d5-5d58-9928-6d29437db91e"
+Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
+Requires = "ae029012-a4dd-5104-9daa-d747884805df"
+TensorBoardLogger = "899adc3e-224a-11e9-021f-63837185c80f"
+
+[weakdeps]
+Turing = "fce5fe82-541a-59a6-adf8-730c64b5f9a0"
+
+[extensions]
+TuringCallbacksTuringExt = "Turing"
+
+[compat]
+DataStructures = "0.18 - 0.19"
+DocStringExtensions = "0.8, 0.9"
+OnlineStats = "1.5"
+Reexport = "0.2, 1.0"
+Requires = "1"
+TensorBoardLogger = "0.1.22"
+Turing = "0.39, 0.40, 0.41, 0.42"
+julia = "1"
+
+[extras]
+Turing = "fce5fe82-541a-59a6-adf8-730c64b5f9a0"

TuringCallbacks/README.md

@@ -0,0 +1,8 @@
+# TuringCallbacks
+
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://turinglang.github.io/Deprecated/TuringCallbacks.jl/stable)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://turinglang.github.io/Deprecated/TuringCallbacks.jl/dev)
+
+A package containing some convenient callbacks to use when you `sample` in [`Turing.jl`](https://github.com/TuringLang/Turing.jl).
+
+See the dev-docs for more information.

TuringCallbacks/docs/Project.toml

@@ -0,0 +1,6 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+TuringCallbacks = "ea0860ee-d0ef-45ef-82e6-cc37d6be2f9c"
+
+[compat]
+Documenter = "1"

TuringCallbacks/docs/make.jl

@@ -0,0 +1,17 @@
+using TuringCallbacks
+using Documenter
+
+makedocs(;
+    modules=[TuringCallbacks],
+    authors="Tor",
+    repo="https://github.com/TuringLang/Deprecated/blob/{commit}{path}#L{line}",
+    sitename="TuringCallbacks.jl",
+    format=Documenter.HTML(;
+        prettyurls=get(ENV, "CI", "false") == "true",
+        canonical="https://turinglang.github.io/Deprecated/TuringCallbacks.jl",
+        assets=String[],
+    ),
+    pages=[
+        "Home" => "index.md",
+    ],
+)