# slcs
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n slcs --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install slcs
```
### nbdev
``` sh
# activate conda environment
$ conda activate slcs
# make sure the slcs package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the slcs package
$ nbdev_prepare
```
### Publishing
``` sh
# publish to pypi
$ nbdev_pypi
# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'
```
# Usage
## Installation
Install latest from the GitHub
[repository](https://github.com/dsm-72/slcs):
``` sh
$ pip install git+https://github.com/dsm-72/slcs.git
```
or from [conda](https://anaconda.org/dsm-72/slcs)
``` sh
$ conda install -c dsm-72 slcs
```
or from [pypi](https://pypi.org/project/slcs/)
``` sh
$ pip install slcs
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/slcs)
[pages](https://dsm-72.github.io/slcs/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/slcs) and
[pypi](https://pypi.org/project/slcs/) respectively.
## PyTorch Documentation:
- [`TorchData`](https://pytorch.org/data/beta/index.html)
- [How to Package PyTorch
Models](https://pytorch.org/docs/stable/package.html)
- [`torch.monitor.Event`](https://pytorch.org/docs/stable/monitor.html#torch.monitor.Event)
- [`torchvision`](https://pytorch.org/vision/stable/index.html)
- [`torchvision.Datasets.VisionDataset`](https://pytorch.org/vision/stable/generated/torchvision.datasets.VisionDataset.html#torchvision.datasets.VisionDataset)
- [`torchvision.utils.flow_to_image`](https://pytorch.org/vision/stable/generated/torchvision.utils.flow_to_image.html)
## PyTorch Models to Consider:
- [Diffusion Video
AutoEncoders](https://github.com/man805/Diffusion-Video-Autoencoders)
- [ConvLSTM
AutoEncoder](https://holmdk.github.io/2020/04/02/video_prediction.html)
- [Recurrent All Pairs Field Transforms for Optical
Flow](https://github.com/princeton-vl/RAFT/blob/master/core/raft.py)
- [Optical Flow Toolbox
(`mmflow`)](https://github.com/open-mmlab/mmflow/blob/master/docs/en/intro.md)
- [`torchvision.models.optical_flow.raft`](https://github.com/pytorch/vision/blob/main/torchvision/models/optical_flow/raft.py)
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/slcs",
"name": "slcs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "slices slice slc slcs",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/e7/56/9cd77753491a4241b7c713ce665383d86836975e83286cd32be4ffe15574/slcs-0.0.1.tar.gz",
"platform": null,
"description": "# slcs\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Developer Guide\n\n### Setup\n\n``` sh\n# create conda environment\n$ mamba env create -f env.yml\n\n# update conda environment\n$ mamba env update -n slcs --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install slcs\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate slcs\n\n# make sure the slcs package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to the slcs package\n$ nbdev_prepare\n```\n\n### Publishing\n\n``` sh\n# publish to pypi\n$ nbdev_pypi\n\n# publish to conda\n$ nbdev_conda --build_args '-c conda-forge'\n$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'\n```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/slcs):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/slcs.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/slcs)\n\n``` sh\n$ conda install -c dsm-72 slcs\n```\n\nor from [pypi](https://pypi.org/project/slcs/)\n\n``` sh\n$ pip install slcs\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/slcs)\n[pages](https://dsm-72.github.io/slcs/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/slcs) and\n[pypi](https://pypi.org/project/slcs/) respectively.\n\n## PyTorch Documentation:\n\n- [`TorchData`](https://pytorch.org/data/beta/index.html)\n- [How to Package PyTorch\n Models](https://pytorch.org/docs/stable/package.html)\n- [`torch.monitor.Event`](https://pytorch.org/docs/stable/monitor.html#torch.monitor.Event)\n- [`torchvision`](https://pytorch.org/vision/stable/index.html)\n- [`torchvision.Datasets.VisionDataset`](https://pytorch.org/vision/stable/generated/torchvision.datasets.VisionDataset.html#torchvision.datasets.VisionDataset)\n- [`torchvision.utils.flow_to_image`](https://pytorch.org/vision/stable/generated/torchvision.utils.flow_to_image.html)\n\n## PyTorch Models to Consider:\n\n- [Diffusion Video\n AutoEncoders](https://github.com/man805/Diffusion-Video-Autoencoders)\n- [ConvLSTM\n AutoEncoder](https://holmdk.github.io/2020/04/02/video_prediction.html)\n- [Recurrent All Pairs Field Transforms for Optical\n Flow](https://github.com/princeton-vl/RAFT/blob/master/core/raft.py)\n- [Optical Flow Toolbox\n (`mmflow`)](https://github.com/open-mmlab/mmflow/blob/master/docs/en/intro.md)\n- [`torchvision.models.optical_flow.raft`](https://github.com/pytorch/vision/blob/main/torchvision/models/optical_flow/raft.py)\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "slices",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/dsm-72/slcs"
},
"split_keywords": [
"slices",
"slice",
"slc",
"slcs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd7c03b38a4573fd3bc2f08b629447de75145dca06654f89841d81999169c559",
"md5": "5f0026ddc3f0674ba1ac161d1a3c7f97",
"sha256": "fcda3914c557293998cf22e958a7b130438cb3239debb89c1af537a32cad8e2e"
},
"downloads": -1,
"filename": "slcs-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f0026ddc3f0674ba1ac161d1a3c7f97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 11327,
"upload_time": "2024-03-10T18:26:45",
"upload_time_iso_8601": "2024-03-10T18:26:45.488519Z",
"url": "https://files.pythonhosted.org/packages/dd/7c/03b38a4573fd3bc2f08b629447de75145dca06654f89841d81999169c559/slcs-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7569cd77753491a4241b7c713ce665383d86836975e83286cd32be4ffe15574",
"md5": "a5841ab5264c47cfda980df781ed5f4c",
"sha256": "b3ded7bde8a81d8c42e315094837dc6b5c86f112d10be91fae31feed557fa1c6"
},
"downloads": -1,
"filename": "slcs-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a5841ab5264c47cfda980df781ed5f4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 12945,
"upload_time": "2024-03-10T18:26:46",
"upload_time_iso_8601": "2024-03-10T18:26:46.784926Z",
"url": "https://files.pythonhosted.org/packages/e7/56/9cd77753491a4241b7c713ce665383d86836975e83286cd32be4ffe15574/slcs-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-10 18:26:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "slcs",
"github_not_found": true,
"lcname": "slcs"
}
JSON
