jaxkan


Namejaxkan JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryA JAX implementation of Kolmogorov-Arnold Networks
upload_time2025-01-07 16:35:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2024 Spyros Rigas, Michalis Papachristou 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.
keywords jax nnx kans kolmogorov-arnold pikan
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Doc](https://img.shields.io/badge/docs-dev-blue.svg)](https://jaxkan.readthedocs.io/)
[![License](https://img.shields.io/github/license/srigas/jaxkan)](https://github.com/srigas/jaxKAN/blob/main/LICENSE)
[![Run Tests](https://github.com/srigas/jaxKAN/actions/workflows/test.yml/badge.svg)](https://github.com/srigas/jaxKAN/actions/workflows/test.yml)
[![PyPI version](https://img.shields.io/pypi/v/jaxkan.svg)](https://pypi.org/project/jaxkan/)

# jaxKAN

jaxKAN is a Python package designed to enable the training of Kolmogorov-Arnold Networks (KANs) using the JAX framework. Built on Flax's NNX module, jaxKAN provides a collection of KAN layers that serve as foundational building blocks for various KAN architectures, such as the EfficientKAN and the ChebyKAN. While it includes standard features like initialization and forward pass methods, the KAN class in jaxKAN introduces an `extend_grids` method, which facilitates the extension of the grids for all layers in the network, irrespective of how those grids are defined. For instance, in the case of ChebyKAN, where a traditional grid concept doesn't exist, the method extends the order of the Chebyshev polynomials utilized in the model.


## Documentation

Extensive documentation on jaxKAN, including installation & contributing guidelines, API reference and tutorials, can be found [here](https://jaxkan.readthedocs.io/).


## Citation

There is a JOSS paper currently submitted under review for jaxKAN. Until it is published, if you utilized `jaxKAN` for your own academic work, please consider using the following citation, which is the paper in which the framework was first introduced for PIKANs:

```
@article{10763509,
      author = {Rigas, Spyros and Papachristou, Michalis and Papadopoulos, Theofilos and Anagnostopoulos, Fotios and Alexandridis, Georgios},
      journal = {IEEE Access}, 
      title = {Adaptive Training of Grid-Dependent Physics-Informed Kolmogorov-Arnold Networks}, 
      year = {2024},
      volume = {12},
      pages = {176982-176998},
      doi = {10.1109/ACCESS.2024.3504962}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "jaxkan",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "JAX, NNX, KANs, Kolmogorov-Arnold, PIKAN",
    "author": null,
    "author_email": "Spyros Rigas <rigassp@gmail.com>, Michalis Papachristou <mixpap@phys.uoa.gr>",
    "download_url": "https://files.pythonhosted.org/packages/22/41/ca82c5c0a406a6a1d4fa3ae89b79269b1db3d1a65ee39e41c08e2d15f22b/jaxkan-0.2.0.tar.gz",
    "platform": null,
    "description": "[![Doc](https://img.shields.io/badge/docs-dev-blue.svg)](https://jaxkan.readthedocs.io/)\n[![License](https://img.shields.io/github/license/srigas/jaxkan)](https://github.com/srigas/jaxKAN/blob/main/LICENSE)\n[![Run Tests](https://github.com/srigas/jaxKAN/actions/workflows/test.yml/badge.svg)](https://github.com/srigas/jaxKAN/actions/workflows/test.yml)\n[![PyPI version](https://img.shields.io/pypi/v/jaxkan.svg)](https://pypi.org/project/jaxkan/)\n\n# jaxKAN\n\njaxKAN is a Python package designed to enable the training of Kolmogorov-Arnold Networks (KANs) using the JAX framework. Built on Flax's NNX module, jaxKAN provides a collection of KAN layers that serve as foundational building blocks for various KAN architectures, such as the EfficientKAN and the ChebyKAN. While it includes standard features like initialization and forward pass methods, the KAN class in jaxKAN introduces an `extend_grids` method, which facilitates the extension of the grids for all layers in the network, irrespective of how those grids are defined. For instance, in the case of ChebyKAN, where a traditional grid concept doesn't exist, the method extends the order of the Chebyshev polynomials utilized in the model.\n\n\n## Documentation\n\nExtensive documentation on jaxKAN, including installation & contributing guidelines, API reference and tutorials, can be found [here](https://jaxkan.readthedocs.io/).\n\n\n## Citation\n\nThere is a JOSS paper currently submitted under review for jaxKAN. Until it is published, if you utilized `jaxKAN` for your own academic work, please consider using the following citation, which is the paper in which the framework was first introduced for PIKANs:\n\n```\n@article{10763509,\n      author = {Rigas, Spyros and Papachristou, Michalis and Papadopoulos, Theofilos and Anagnostopoulos, Fotios and Alexandridis, Georgios},\n      journal = {IEEE Access}, \n      title = {Adaptive Training of Grid-Dependent Physics-Informed Kolmogorov-Arnold Networks}, \n      year = {2024},\n      volume = {12},\n      pages = {176982-176998},\n      doi = {10.1109/ACCESS.2024.3504962}\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Spyros Rigas, Michalis Papachristou  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. ",
    "summary": "A JAX implementation of Kolmogorov-Arnold Networks",
    "version": "0.2.0",
    "project_urls": {
        "Issues": "https://github.com/srigas/jaxkan/issues",
        "Repository": "https://github.com/srigas/jaxkan"
    },
    "split_keywords": [
        "jax",
        " nnx",
        " kans",
        " kolmogorov-arnold",
        " pikan"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a91b4a16f9d9ff1405b27beedd59b58def43aafa1fc6a4d8cf7f0df5ee6bda0c",
                "md5": "7d97936d10f311d29103c20fb7067cb3",
                "sha256": "cd176d547aefd3ad3feff59d3379aaa42749d40c40d68ca8b58290ececbacd1e"
            },
            "downloads": -1,
            "filename": "jaxkan-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7d97936d10f311d29103c20fb7067cb3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 25307,
            "upload_time": "2025-01-07T16:35:46",
            "upload_time_iso_8601": "2025-01-07T16:35:46.719911Z",
            "url": "https://files.pythonhosted.org/packages/a9/1b/4a16f9d9ff1405b27beedd59b58def43aafa1fc6a4d8cf7f0df5ee6bda0c/jaxkan-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2241ca82c5c0a406a6a1d4fa3ae89b79269b1db3d1a65ee39e41c08e2d15f22b",
                "md5": "16e23789467706d7a8aee9edba6df9ca",
                "sha256": "f50b6001d00b1750f6ab6c43caa4eaf617d081b34e0b1dd76c4cf39700b38d4d"
            },
            "downloads": -1,
            "filename": "jaxkan-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "16e23789467706d7a8aee9edba6df9ca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 22842,
            "upload_time": "2025-01-07T16:35:47",
            "upload_time_iso_8601": "2025-01-07T16:35:47.731075Z",
            "url": "https://files.pythonhosted.org/packages/22/41/ca82c5c0a406a6a1d4fa3ae89b79269b1db3d1a65ee39e41c08e2d15f22b/jaxkan-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-07 16:35:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "srigas",
    "github_project": "jaxkan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "jaxkan"
}
        
Elapsed time: 0.55741s