nqxpack 0.1.1__tar.gz

nqxpack-0.1.1/.github/copybara/common-nqx.bara.sky

@@ -0,0 +1,51 @@
+push_commons = [
+    ".github/copybara/common-**",
+    "test/common/**",
+]
+push_exclide_common = [
+    "**/_version.py",
+    "deepnets/**",
+    "ext/**",
+    "README.md",
+    "LICENSE",
+    "pyproject.toml",
+]
+destination_common = [
+    ".github/copybara/common-**",
+    "test/common/**",
+]
+
+copybara_transforms = [
+    core.move("packages/nqxpack", "nqxpack/"),
+    # core.move("test/nqxpack", "test/nqxpack"),
+    # core.move("test/common", "test/common"),
+    core.move("design/nqxpack", "design"),
+    # core.move("docs/packages/nqxpack", "docs/nqxpack"),
+]
+
+os_config = {
+    "PUSH_TRANSFORMATIONS": copybara_transforms,
+    "PR_TRANSFORMATIONS": core.reverse(copybara_transforms),
+    "PUSH_INCLUDE": [
+        ".github/copybara/oss-nqx**",
+        "packages/nqxpack/**",
+        "test/nqxpack/**",
+        "design/nqxpack/**",
+        "examples/nqxpack/**",
+        "docs/packages/nqxpack/**",
+    ] + push_commons,
+    "PUSH_EXCLUDE": [
+
+    ] + push_exclide_common,
+    "DESTINATION_INCLUDE": [
+        ".github/copybara/oss-nqx**",
+        "nqxpack/**",
+        "test/nqxpack/**",
+        "design/**",
+        "examples/**",
+        "docs/nqxpack/**",
+    ] + destination_common,
+    "DESTINATION_EXCLUDE": [
+        "**/_version.py"
+    ]
+}

nqxpack-0.1.1/.github/copybara/common-template-copybara.bara.sky

@@ -0,0 +1,65 @@
+# Variables
+config = {
+    "SOT_REPO" : "git@github.com:<sot_repo>.git",
+    "SOT_BRANCH" : "<branch_to_sync>",
+    "DESTINATION_REPO" : "git@github.com:<destination_repo>.git",
+    "DESTINATION_BRANCH" : "<branch_to_sync>",
+    "COMMITTER" : "Quantum AI Lab Bot <quantumailabx@gmail.com>",
+    #"LOCAL_SOT" : "file:///usr/src/app",
+}
+
+def add_comment_with_shadow_pr(ctx):
+   ctx.console.info("Adding comment about internal PR to the original PR")
+   pr_number = ctx.revision.labels["GITHUB_PR_NUMBER"][0]
+   for effect in ctx.effects:
+       if effect.type == "CREATED" and effect.destination_ref != None and effect.destination_ref.url != None:
+              ctx.origin.post_issue_comment(int(pr_number), "Internal PR " + effect.destination_ref.url.replace("https://github.com/","").replace("/pull/","#") + "\nInternal message only. Nothing to see here, move along")
+
+def pr_workflow(config, repo_config):
+   core.workflow(
+       name = "pr",
+       origin = git.github_pr_origin(
+           url = config["DESTINATION_REPO"],
+           branch = config["DESTINATION_BRANCH"],
+       ),
+       destination = git.github_pr_destination(
+           url = config["SOT_REPO"],
+           destination_ref = config["SOT_BRANCH"],
+           integrates = [],
+           title = "${GITHUB_PR_TITLE}",
+           update_description = True,
+           pr_branch = "imported/" + config["DESTINATION_REPO"].replace("git@github.com:", "").replace(".git", "") + "/${CONTEXT_REFERENCE}",
+       ),
+       destination_files = glob(repo_config["PUSH_INCLUDE"], exclude = repo_config["PUSH_EXCLUDE"]),
+       origin_files = glob(repo_config["DESTINATION_INCLUDE"], exclude = repo_config["DESTINATION_EXCLUDE"]),
+       authoring = authoring.pass_thru(default = config["COMMITTER"]),
+       mode = "CHANGE_REQUEST",
+       set_rev_id = False,
+       transformations = [
+           metadata.squash_notes(prefix='Import of ${GITHUB_PR_URL}\n\n**Original PR description:**\n\n${GITHUB_PR_BODY}\n\nImported changes:\n\n', oldest_first = True, show_author=False),
+           metadata.expose_label("GITHUB_PR_NUMBER", new_name = "Closes", separator = config["DESTINATION_REPO"].replace("git@github.com:", " ").replace(".git", "#")),
+           metadata.save_author("ORIGINAL_AUTHOR"),
+       ] + repo_config["PR_TRANSFORMATIONS"],
+       # after_workflow = [add_comment_with_shadow_pr],
+   )
+
+def push_workflow(config, repo_config):
+    core.workflow(
+        name = "push",
+        origin = git.origin(
+            url = config["SOT_REPO"], # config["LOCAL_SOT"] if config["LOCAL_SOT"] else config["SOT_REPO"],
+            ref = config["SOT_BRANCH"],
+        ),
+        destination = git.github_destination(
+            url = config["DESTINATION_REPO"],
+            push = config["DESTINATION_BRANCH"],
+        ),
+        origin_files = glob(repo_config["PUSH_INCLUDE"], exclude = repo_config["PUSH_EXCLUDE"]),
+        destination_files=glob(repo_config["DESTINATION_INCLUDE"], exclude = repo_config["DESTINATION_EXCLUDE"]),
+        authoring = authoring.pass_thru(default = config["COMMITTER"]),
+        mode = "ITERATIVE",
+        transformations = [
+            metadata.restore_author("ORIGINAL_AUTHOR", search_all_changes = True),
+            metadata.expose_label("COPYBARA_INTEGRATE_REVIEW"),
+        ] + core.reverse(repo_config["PR_TRANSFORMATIONS"]),
+    )

nqxpack-0.1.1/.github/copybara/oss-nqx.bara.sky

@@ -0,0 +1,5 @@
+load("app/.github/copybara/common-copybara", "config", "pr_workflow")
+
+load("app/.github/copybara/common-nqx", "os_config")
+
+pr_workflow(config, os_config)

nqxpack-0.1.1/.github/workflows/CI.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  pull_request:
+
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ !contains(github.ref, 'master')}}
+
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            python-version: "3.12"
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+          fetch-tags: true
+
+      - name: Install the latest version of uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+  
+      - name: Tests
+        run: |
+          uv run pytest
+
+      # - name: Upload coverage reports to Codecov
+      #   if: always()
+      #   uses: codecov/codecov-action@v4
+      #   with:
+      #     token: ${{ secrets.CODECOV_TOKEN }} # required
+      #     verbose: true # optional (default = false)

nqxpack-0.1.1/.github/workflows/copybara.yml

@@ -0,0 +1,83 @@
+name: Copybara
+on:
+  pull_request_target:
+    branches:
+      - "main"
+    types:
+      - reopened
+      - opened
+      - synchronize
+      - edited
+env:
+  branch_to_sync: ${{ github.base_ref || github.ref_name}}
+  sot_repo: NeuralQXLab/netket_pro
+  destination_repo: NeuralQXLab/nqxpack
+  commiter_name: "Quantum AI Lab @ X - Automation Bot"
+  commiter_email: "quantumailabx@gmail.com"
+  copybara_config: ".github/copybara/oss-nqx.bara.sky"
+
+jobs:
+  copybara-os-pr:
+    name: Mirror-pr
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up SSH key
+        run: |
+          mkdir -p ~/.ssh
+          echo "$SSH_PRIV_KEY" > ~/.ssh/id_rsa
+          chmod 600 ~/.ssh/id_rsa
+          ssh-keyscan -H github.com >> ~/.ssh/known_hosts
+          echo "https://x-access-token:${GH_TOKEN}@api.github.com" > ~/.git-credentials
+        env:
+          SSH_PRIV_KEY: ${{ secrets.SSH_GH_KEY }}
+          GH_TOKEN: ${{ secrets.GH_BOT_GITHUB_TOKEN }}
+
+      - name: Set up Git config
+        run: |
+          git config --global user.name "${{ env.commiter_name }}"
+          git config --global user.email "${{ env.commiter_email }}"
+
+      - name: Reopen referenced PRs
+        if: github.event.action == 'reopened'
+        run: |
+          PR_NUMBER="${{ github.event.pull_request.number }}"
+          CONTENT="$(gh pr view "$PR_NUMBER" --json "body,comments" -q '.body, .comments[].body' | tac)"
+
+          while read -r line; do
+            if [[ $line =~ (Closes|Internal\ PR)\ ([^/]+)/([^/]+)#([0-9]+) ]]; then
+              OWNER="${BASH_REMATCH[2]}"
+              REPO="${BASH_REMATCH[3]}"
+              OTHER_PR="${BASH_REMATCH[4]}"
+              echo "Reopening PR: $OWNER/$REPO/$OTHER_PR"
+              gh pr reopen --repo "$OWNER/$REPO" \
+               --comment "This pull request has been reopened because of reopening of https://github.com/${{ github.repository }}/pull/${PR_NUMBER}" \
+              $OTHER_PR
+            fi
+          done <<< "$CONTENT"
+        env:
+          GH_TOKEN: ${{ secrets.GH_BOT_GITHUB_TOKEN }}
+      - name: Generate copybara config file
+        run: |
+          sed -e 's#<branch_to_sync>#${{ env.branch_to_sync }}#' \
+              -e 's#<sot_repo>#${{ env.sot_repo }}#' \
+              -e 's#<destination_repo>#${{ env.destination_repo }}#' \
+              .github/copybara/common-template-copybara.bara.sky > .github/copybara/common-copybara.bara.sky
+
+      - name: Show config being used
+        run: |
+          cat .github/copybara/common-copybara.bara.sky
+          cat ${{ env.copybara_config }}
+
+      - uses: hazelcast/copybara-action@main
+        name: "Copybara PR #${{ github.event.pull_request.number }} -> ${{ env.branch_to_sync }}"
+        with:
+          ssh_key: ${{ secrets.SSH_GH_KEY }}
+          access_token: ${{ secrets.GH_BOT_GITHUB_TOKEN }}
+          sot_repo: ${{ env.sot_repo }}
+          sot_branch: ${{ env.branch_to_sync }}
+          destination_repo: ${{ env.destination_repo }}
+          copybara_options: "--nogit-destination-rebase"
+          committer: "${{ env.commiter_name }} <${{ env.commiter_email }}>"
+          custom_config: ${{ env.copybara_config }}

nqxpack-0.1.1/.github/workflows/formatting_check.yml

@@ -0,0 +1,26 @@
+name: Checks
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  pull_request:
+
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+
+
+jobs:
+  pre-commit:
+    name: Format and Lint (pre-commit)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+      with:
+        python-version: "3.12"
+
+    - uses: pre-commit/action@v3.0.1

nqxpack-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Publish to PyPi
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/netket
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      # make sure tags are fetched so we can get a version
+      - run: |
+          git fetch --prune --unshallow --tags
+
+      - name: Install the latest version of uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build
+        run: |
+          uv build
+      
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

nqxpack-0.1.1/.gitignore

@@ -0,0 +1,147 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+uv.lock
+
+
+# C extensions
+*.so
+
+# Distribution / packaging
+netket_pro/_version.py
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+.envrc
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+.virtual_ocuments
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+#jsons
+*.json
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+.DS_Store
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.ruff_cache
+.lprof
+.benchmarks
+
+# Pyre type checker
+.pyre/
+
+# Website #
+###########
+docs/_build
+_generated
+dist

nqxpack-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.9.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+    - id: black

nqxpack-0.1.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: nqxpack
+Version: 0.1.1
+Summary: Library to serialise objects arising from scientific and Machine Learning libraries, including NetKet.
+Author-email: Filippo Vicentini <filippovicentini@gmail.com>
+Requires-Python: >=3.10
+Requires-Dist: flax>=0.10.2
+Requires-Dist: jax>=0.4.35
+Requires-Dist: netket>=3.16.0.post2
+Requires-Dist: numpy>=2
+Requires-Dist: omegaconf>=2
+Description-Content-Type: text/markdown
+
+# NQXPack
+
+A library to save and load objects coming from Scientific Machine Learning libraries, with a special attention to Neural Quantum States from NetKet.
+
+Goals:
+- Simple format, possible to hand-edit and inspect manually;
+- Compatibility among Python version;
+- Allows to load Neural Networks with a single ``load`` command;
+
+## Usage
+
+Install with 
+
+```bash
+uv add git+https://github.com/NeuralQXLab/nqxpack.git
+```
+or (but seriously, stop using pip and start using uv)
+```bash
+pip install git+https://github.com/NeuralQXLab/nqxpack.git
+```
+
+
+### With `flax.linen`
+
+Save a dictionary containing the model and the parameters.
+
+```python
+import nqxpack
+import jax
+from flax import linen as nn
+
+model = nn.Sequential(
+    nn.Dense(features=2),
+    nn.gelu,
+    nn.Dense(features=1),
+    jax.numpy.squeeze,
+)
+
+variables = model.init(jax.random.key(1), jax.numpy.ones((2,4)))
+
+nqxpack.save({'model':model, 'variables':variables}, "mymodel.nk")
+
+loaded_dict = nqxpack.load("mymodel.nk")
+loaded_model, loaded_variables = loaded_dict['model'], loaded_dict['variables']
+```
+
+### With NetKet
+
+```python
+import nqxpack
+import netket as nk
+
+hi = nk.hilbert.Spin(0.5, 10)
+operator = nk.operator.spin.sigmax(nqs_state.hilbert, 1)
+
+nqs_state = nk.vqs.MCState(nk.sampler.MetropolisLocal(hi), nk.models.RBM(alpha=4))
+# print expectation value:
+nqs_state.expect(operator)
+
+nqxpack.save(nqs_state, "nqs_state.nk")
+nqs_state_loaded = nqxpack.load("nqs_state.nk")
+
+nqs_state_loaded.expect(operator)
+```
+
+## The format
+
+The format is a single zip file. You can decompress it yourself and look into it.
+
+## Feedback required
+
+If you use this library, please let us know of any issue you might find.

nqxpack-0.1.1/README.md

@@ -0,0 +1,72 @@
+# NQXPack
+
+A library to save and load objects coming from Scientific Machine Learning libraries, with a special attention to Neural Quantum States from NetKet.
+
+Goals:
+- Simple format, possible to hand-edit and inspect manually;
+- Compatibility among Python version;
+- Allows to load Neural Networks with a single ``load`` command;
+
+## Usage
+
+Install with 
+
+```bash
+uv add git+https://github.com/NeuralQXLab/nqxpack.git
+```
+or (but seriously, stop using pip and start using uv)
+```bash
+pip install git+https://github.com/NeuralQXLab/nqxpack.git
+```
+
+
+### With `flax.linen`
+
+Save a dictionary containing the model and the parameters.
+
+```python
+import nqxpack
+import jax
+from flax import linen as nn
+
+model = nn.Sequential(
+    nn.Dense(features=2),
+    nn.gelu,
+    nn.Dense(features=1),
+    jax.numpy.squeeze,
+)
+
+variables = model.init(jax.random.key(1), jax.numpy.ones((2,4)))
+
+nqxpack.save({'model':model, 'variables':variables}, "mymodel.nk")
+
+loaded_dict = nqxpack.load("mymodel.nk")
+loaded_model, loaded_variables = loaded_dict['model'], loaded_dict['variables']
+```
+
+### With NetKet
+
+```python
+import nqxpack
+import netket as nk
+
+hi = nk.hilbert.Spin(0.5, 10)
+operator = nk.operator.spin.sigmax(nqs_state.hilbert, 1)
+
+nqs_state = nk.vqs.MCState(nk.sampler.MetropolisLocal(hi), nk.models.RBM(alpha=4))
+# print expectation value:
+nqs_state.expect(operator)
+
+nqxpack.save(nqs_state, "nqs_state.nk")
+nqs_state_loaded = nqxpack.load("nqs_state.nk")
+
+nqs_state_loaded.expect(operator)
+```
+
+## The format
+
+The format is a single zip file. You can decompress it yourself and look into it.
+
+## Feedback required
+
+If you use this library, please let us know of any issue you might find.