vicregaddon

Name	vicregaddon JSON
Version	0.0.4 JSON
	download
home_page	https://github.com/drscotthawley/vicregaddon
Summary	A lightweight and modular parallel PyTorch implementation of VICReg (intended for audio, but will try to be general)
upload_time	2024-05-07 00:51:10
maintainer	None
docs_url	None
author	Scott H. Hawley
requires_python	None
license	MIT
keywords
VCS
bugtrack_url
requirements	torch einops
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # vicregaddon

> *"vicreg add-on".  As in "Yeah, but are you getting it? vicregaddon it"*

A lightweight and modular parallel PyTorch implementation of [VICReg](https://github.com/facebookresearch/vicreg). 

(I intend this for audio, but could be used for other things)

## Installation: 

```bash
pip install vicregaddon
```
or, for the most recent version
```
pip install git+https://github.com/drscotthawley/vicregaddon.git
```


## Usage:
```python
from vicregaddon import *
```

## Dependencies: 

- torch
- einops

In the library itself, parallelism is handled directly via `torch.distributed` and thus is "agnostic" to whether PyTorch Lightning or Accelerate (or some other thing) is used.

The `examples/` however, have several more dependencies. You will need to install Lightning and/or Accelerate and/or other things to run them, depending on each example.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/drscotthawley/vicregaddon",
    "name": "vicregaddon",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Scott H. Hawley",
    "author_email": "scott.hawley@belmont.edu",
    "download_url": "https://files.pythonhosted.org/packages/10/a4/fa87ea6d1eb4cf4334963919aea21acac8062a3eab4213bd8729ee71705f/vicregaddon-0.0.4.tar.gz",
    "platform": null,
    "description": "# vicregaddon\n\n> *\"vicreg add-on\".  As in \"Yeah, but are you getting it? vicregaddon it\"*\n\nA lightweight and modular parallel PyTorch implementation of [VICReg](https://github.com/facebookresearch/vicreg). \n\n(I intend this for audio, but could be used for other things)\n\n## Installation: \n\n```bash\npip install vicregaddon\n```\nor, for the most recent version\n```\npip install git+https://github.com/drscotthawley/vicregaddon.git\n```\n\n\n## Usage:\n```python\nfrom vicregaddon import *\n```\n\n## Dependencies: \n\n- torch\n- einops\n\nIn the library itself, parallelism is handled directly via `torch.distributed` and thus is \"agnostic\" to whether PyTorch Lightning or Accelerate (or some other thing) is used.\n\nThe `examples/` however, have several more dependencies. You will need to install Lightning and/or Accelerate and/or other things to run them, depending on each example.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A lightweight and modular parallel PyTorch implementation of VICReg (intended for audio, but will try to be general)",
    "version": "0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/drscotthawley/vicregaddon"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "32cb6c13a6b9a7f38dedc4e5a5c84539dcd1f49e99e91a0deb1bc2fe56dfe7a1",
                "md5": "97bea42ae00f8fe6ebf606bf3fdaeae4",
                "sha256": "419f2b04d2043ac6d3c71d29a09eecece24fa05d6feab9d3011ec5341347e3b3"
            },
            "downloads": -1,
            "filename": "vicregaddon-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "97bea42ae00f8fe6ebf606bf3fdaeae4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7416,
            "upload_time": "2024-05-07T00:51:08",
            "upload_time_iso_8601": "2024-05-07T00:51:08.379250Z",
            "url": "https://files.pythonhosted.org/packages/32/cb/6c13a6b9a7f38dedc4e5a5c84539dcd1f49e99e91a0deb1bc2fe56dfe7a1/vicregaddon-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "10a4fa87ea6d1eb4cf4334963919aea21acac8062a3eab4213bd8729ee71705f",
                "md5": "bf63ee5f0a418668bb68ce1b3ac4697c",
                "sha256": "8d9f16b607ad5b27af605965384e61f216302ee567bc8e8db3d1cd803e14a8a0"
            },
            "downloads": -1,
            "filename": "vicregaddon-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "bf63ee5f0a418668bb68ce1b3ac4697c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6528,
            "upload_time": "2024-05-07T00:51:10",
            "upload_time_iso_8601": "2024-05-07T00:51:10.602968Z",
            "url": "https://files.pythonhosted.org/packages/10/a4/fa87ea6d1eb4cf4334963919aea21acac8062a3eab4213bd8729ee71705f/vicregaddon-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-07 00:51:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "drscotthawley",
    "github_project": "vicregaddon",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "torch",
            "specs": []
        },
        {
            "name": "einops",
            "specs": []
        }
    ],
    "lcname": "vicregaddon"
}