jaxkan


Namejaxkan JSON
Version 0.2.8 PyPI version JSON
download
home_pageNone
SummaryA JAX implementation of Kolmogorov-Arnold Networks
upload_time2025-04-09 10:55:48
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.
            [![DOI](https://joss.theoj.org/papers/10.21105/joss.07830/status.svg)](https://doi.org/10.21105/joss.07830)
[![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/).


## Contributing

We warmly welcome community contributions to jaxKAN! For details on the types of contributions that will help jaxKAN evolve, as well as guidelines on how to contribute, visit [this](https://jaxkan.readthedocs.io/en/latest/contributing.html) page of our documentation.


## Citation

If you utilized `jaxKAN` for your own academic work, please use the following citation:

```
@article{Rigas2025,
      author = {Rigas, Spyros and Papachristou, Michalis},
      title = {jax{KAN}: A unified {JAX} framework for {K}olmogorov-{A}rnold Networks},
      journal = {Journal of Open Source Software},
      year = {2025},
      volume = {10},
      number = {108},
      pages = {7830},
      doi = {10.21105/joss.07830}
}
```

If you have used jaxKAN in your research for PIKAN-related applications or theoretical developments, please consider also citing the paper that originally introduced jaxKAN for these tasks:

```
@article{10763509,
      author = {Rigas, Spyros and Papachristou, Michalis and Papadopoulos, Theofilos and Anagnostopoulos, Fotios and Alexandridis, Georgios},
      title = {Adaptive Training of Grid-Dependent Physics-Informed {K}olmogorov-{A}rnold Networks}, 
      journal = {IEEE Access},
      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/97/87/d90258e9fafd5b3964c861895b9580bf2e591908c30ee4dbb2d2da5bab80/jaxkan-0.2.8.tar.gz",
    "platform": null,
    "description": "[![DOI](https://joss.theoj.org/papers/10.21105/joss.07830/status.svg)](https://doi.org/10.21105/joss.07830)\n[![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## Contributing\n\nWe warmly welcome community contributions to jaxKAN! For details on the types of contributions that will help jaxKAN evolve, as well as guidelines on how to contribute, visit [this](https://jaxkan.readthedocs.io/en/latest/contributing.html) page of our documentation.\n\n\n## Citation\n\nIf you utilized `jaxKAN` for your own academic work, please use the following citation:\n\n```\n@article{Rigas2025,\n      author = {Rigas, Spyros and Papachristou, Michalis},\n      title = {jax{KAN}: A unified {JAX} framework for {K}olmogorov-{A}rnold Networks},\n      journal = {Journal of Open Source Software},\n      year = {2025},\n      volume = {10},\n      number = {108},\n      pages = {7830},\n      doi = {10.21105/joss.07830}\n}\n```\n\nIf you have used jaxKAN in your research for PIKAN-related applications or theoretical developments, please consider also citing the paper that originally introduced jaxKAN for these tasks:\n\n```\n@article{10763509,\n      author = {Rigas, Spyros and Papachristou, Michalis and Papadopoulos, Theofilos and Anagnostopoulos, Fotios and Alexandridis, Georgios},\n      title = {Adaptive Training of Grid-Dependent Physics-Informed {K}olmogorov-{A}rnold Networks}, \n      journal = {IEEE Access},\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\n        \n        Copyright (c) 2024 Spyros Rigas, Michalis Papachristou\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "A JAX implementation of Kolmogorov-Arnold Networks",
    "version": "0.2.8",
    "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": null,
            "digests": {
                "blake2b_256": "baa1ce99fa6564841fed0164fb6a0a8ac9f4c2b351c5463316d0c88ad4062e62",
                "md5": "84a7cc5d1ff7472cecad49f7968c7678",
                "sha256": "cfe74522e59da836b9c9c961a0a3db28f480d8c045a3eea9af9beb891541f77c"
            },
            "downloads": -1,
            "filename": "jaxkan-0.2.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "84a7cc5d1ff7472cecad49f7968c7678",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 41485,
            "upload_time": "2025-04-09T10:55:46",
            "upload_time_iso_8601": "2025-04-09T10:55:46.457011Z",
            "url": "https://files.pythonhosted.org/packages/ba/a1/ce99fa6564841fed0164fb6a0a8ac9f4c2b351c5463316d0c88ad4062e62/jaxkan-0.2.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9787d90258e9fafd5b3964c861895b9580bf2e591908c30ee4dbb2d2da5bab80",
                "md5": "ad97f5c350fa21412e5f8135418fa691",
                "sha256": "4f6008883e8ab60014822dade8134172554bec5c476cdcbdc4c2e3cb39013d7e"
            },
            "downloads": -1,
            "filename": "jaxkan-0.2.8.tar.gz",
            "has_sig": false,
            "md5_digest": "ad97f5c350fa21412e5f8135418fa691",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 28722,
            "upload_time": "2025-04-09T10:55:48",
            "upload_time_iso_8601": "2025-04-09T10:55:48.378144Z",
            "url": "https://files.pythonhosted.org/packages/97/87/d90258e9fafd5b3964c861895b9580bf2e591908c30ee4dbb2d2da5bab80/jaxkan-0.2.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-04-09 10:55:48",
    "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: 1.31430s