pcax

Name	pcax JSON
Version	0.1.0 JSON
	download
home_page
Summary	Minimal Principal Component Analysis (PCA) implementation using JAX.
upload_time	2023-05-29 12:20:21
maintainer
docs_url	None
author
requires_python	>=3.9
license	MIT License Copyright (c) 2023 Albert Alonso 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 pca machine-learning
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # pcax
Minimal Principal Component Analsys (PCA) implementation using jax.

The aim of this project is to provide a JAX-based PCA implementation, eliminating the need for unnecessary data transfer to CPU or conversions to Numpy. This can provide performance benefits when working with large datasets or in GPU-intensive workflow

## Usage
```python
import pcax

# Fit the PCA model with 3 components on your data X
state = pcax.fit(X, n_components=3)

# Transform X to its principal components
X_pca = pcax.transform(state, X)

# Recover the original X from its principal components
X_recover = pcax.recover(state, X_pca)
```

## Installation
`pcax` can be installed from PyPI via `pip`
```
pip install pcax
```

Alternatively, it can be installed directly from the GitHub repository:
```
pip install git+git://github.com/alonfnt/pcax.git
```


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pcax",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "jax,pca,machine-learning",
    "author": "",
    "author_email": "Albert Alonso <alonfnt@pm.me>",
    "download_url": "https://files.pythonhosted.org/packages/d7/71/662ff67c3eb5a68208344c951748a960bc142790c897642d1bab1d21f456/pcax-0.1.0.tar.gz",
    "platform": null,
    "description": "# pcax\nMinimal Principal Component Analsys (PCA) implementation using jax.\n\nThe aim of this project is to provide a JAX-based PCA implementation, eliminating the need for unnecessary data transfer to CPU or conversions to Numpy. This can provide performance benefits when working with large datasets or in GPU-intensive workflow\n\n## Usage\n```python\nimport pcax\n\n# Fit the PCA model with 3 components on your data X\nstate = pcax.fit(X, n_components=3)\n\n# Transform X to its principal components\nX_pca = pcax.transform(state, X)\n\n# Recover the original X from its principal components\nX_recover = pcax.recover(state, X_pca)\n```\n\n## Installation\n`pcax` can be installed from PyPI via `pip`\n```\npip install pcax\n```\n\nAlternatively, it can be installed directly from the GitHub repository:\n```\npip install git+git://github.com/alonfnt/pcax.git\n```\n\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Albert Alonso  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": "Minimal Principal Component Analysis (PCA) implementation using JAX.",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/alonfnt/pcax/issues",
        "Documentation": "https://github.com/alonfnt/pcax",
        "Homepage": "https://github.com/alonfnt/pcax",
        "Source": "https://github.com/alonfnt/pcax"
    },
    "split_keywords": [
        "jax",
        "pca",
        "machine-learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f89842f4aee4505a9f809c20c2622f85fadb86adfdccb365b7d8faebd445acca",
                "md5": "0c44869bd284183c923b559107d671df",
                "sha256": "8d1d1fa4d68314196d28d9b4489c9f71999ad059a7bae4a301f485ccf05a2c13"
            },
            "downloads": -1,
            "filename": "pcax-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0c44869bd284183c923b559107d671df",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4285,
            "upload_time": "2023-05-29T12:20:20",
            "upload_time_iso_8601": "2023-05-29T12:20:20.194426Z",
            "url": "https://files.pythonhosted.org/packages/f8/98/42f4aee4505a9f809c20c2622f85fadb86adfdccb365b7d8faebd445acca/pcax-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d771662ff67c3eb5a68208344c951748a960bc142790c897642d1bab1d21f456",
                "md5": "c3cceb53e334be5092c66dcd5121b000",
                "sha256": "0831e31bf62554876080f33e1ad9c18f9ae500ef09ed70f5759a6326a8812327"
            },
            "downloads": -1,
            "filename": "pcax-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c3cceb53e334be5092c66dcd5121b000",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 3980,
            "upload_time": "2023-05-29T12:20:21",
            "upload_time_iso_8601": "2023-05-29T12:20:21.402857Z",
            "url": "https://files.pythonhosted.org/packages/d7/71/662ff67c3eb5a68208344c951748a960bc142790c897642d1bab1d21f456/pcax-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-29 12:20:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "alonfnt",
    "github_project": "pcax",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pcax"
}