| Name | swak JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | Swiss army knife for functional data-science projects. |
| upload_time | 2024-10-23 14:55:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
functional
tools
utilities
helpers
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# swak
_Swiss army knife for functional data-science projects._
## Introduction
This package is a collection of small, modular, and composable building
blocks implementing frequently occurring operations in typical data-science
applications. In abstracting away boiler-plate code, it thus saves time and effort.
* Consolidate all ways to configure your project (command-line arguments,
environment variables, and config files) with the `cli` and `text`
packages, respectively.
* Wrap the project config into a versatile `jsonobject`.
* Focus on writing small, configurable, modular, reusable, and testable
building blocks. Then use the flow controls in `funcflow` to compose them
into arbitrarily complex workflows, that are still easy to maintain and to expand.
* Quickly set up projects on Google BigQuery and Google Cloud Storage, and
efficiently download lots of data in parallel with `cloud.gcp`.
* Build powerful neural-network architectures from the elements in `pt` and
train your deep-learning models with early stopping and checkpointing.
From feature embedding, over feature importance, to repeated residual blocks,
a broad variety of options is available.
* And much more ...
## Installation
* Create a new virtual environment running at least `python 3.12`.
* The easiest way of installing `swak` is from the python package index
[PyPI](https://pypi.org/project/swak/), where it is hosted. Simply type
```shell
pip install swak
```
or treat it like any other python package in your dependency management.
* If you need support for interacting with the Google Cloud Project,
in particular Google BigQuery and Google Cloud Storage, install
_extra_ dependencies with:
```shell
pip install swak[cloud]
```
* In order to use the subpackage `swak.pt`, you need to have [PyTorch](https://pytorch.org/) installed.
Because there is no way of knowing whether you want to run it on CPU only or also on GPU and, if so,
which version of CUDA (or ROC) you have installed on your machine and how, it is not an explicit
dependency of `swak`. You will have to install it yourself, _e.g._, following
[these instructions](https://pytorch.org/get-started/locally/).
If you are using `pipenv` for dependency management, you can also have a look at the
[Pipfile](https://github.com/yedivanseven/swak/blob/main/Pipfile) in the root of the `swak`
[repository](https://github.com/yedivanseven/swak) and taylor it to your needs. Personally, I go
```shell
pipenv sync --categories=cpu
```
for a CPU only installation of PyTorch and
```shell
pipenv sync --categories=cuda
```
if I want GPU support.
## Usage
Try making a new repository using the [swak-template](https://github.com/yedivanseven/swak-template)
as a, well, template.
## Documentation
The API documentation to `swak` is hosted on [GitHub Pages](https://yedivanseven.github.io/swak/).
Raw data
{
"_id": null,
"home_page": null,
"name": "swak",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "functional, tools, utilities, helpers",
"author": null,
"author_email": "yedivanseven <yedivanseven@outlook.de>",
"download_url": "https://files.pythonhosted.org/packages/f2/29/450629ea8c08dd43578760361fe20e2ed158b2c8897588be061e746552ad/swak-0.1.5.tar.gz",
"platform": null,
"description": "\n\n\n# swak\n_Swiss army knife for functional data-science projects._\n\n## Introduction\nThis package is a collection of small, modular, and composable building\nblocks implementing frequently occurring operations in typical data-science\napplications. In abstracting away boiler-plate code, it thus saves time and effort.\n* Consolidate all ways to configure your project (command-line arguments,\n environment variables, and config files) with the `cli` and `text`\n packages, respectively.\n* Wrap the project config into a versatile `jsonobject`.\n* Focus on writing small, configurable, modular, reusable, and testable \n building blocks. Then use the flow controls in `funcflow` to compose them\n into arbitrarily complex workflows, that are still easy to maintain and to expand.\n* Quickly set up projects on Google BigQuery and Google Cloud Storage, and\n efficiently download lots of data in parallel with `cloud.gcp`.\n* Build powerful neural-network architectures from the elements in `pt` and\n train your deep-learning models with early stopping and checkpointing.\n From feature embedding, over feature importance, to repeated residual blocks,\n a broad variety of options is available.\n* And much more ...\n\n## Installation\n* Create a new virtual environment running at least `python 3.12`.\n* The easiest way of installing `swak` is from the python package index\n[PyPI](https://pypi.org/project/swak/), where it is hosted. Simply type\n ```shell\n pip install swak\n ```\n or treat it like any other python package in your dependency management.\n* If you need support for interacting with the Google Cloud Project,\nin particular Google BigQuery and Google Cloud Storage, install\n_extra_ dependencies with:\n ```shell\n pip install swak[cloud]\n ```\n* In order to use the subpackage `swak.pt`, you need to have [PyTorch](https://pytorch.org/) installed.\nBecause there is no way of knowing whether you want to run it on CPU only or also on GPU and, if so,\nwhich version of CUDA (or ROC) you have installed on your machine and how, it is not an explicit\ndependency of `swak`. You will have to install it yourself, _e.g._, following\n[these instructions](https://pytorch.org/get-started/locally/).\nIf you are using `pipenv` for dependency management, you can also have a look at the\n[Pipfile](https://github.com/yedivanseven/swak/blob/main/Pipfile) in the root of the `swak`\n[repository](https://github.com/yedivanseven/swak) and taylor it to your needs. Personally, I go\n ```shell\n pipenv sync --categories=cpu\n ```\n for a CPU only installation of PyTorch and\n ```shell\n pipenv sync --categories=cuda\n ```\n if I want GPU support.\n\n## Usage\nTry making a new repository using the [swak-template](https://github.com/yedivanseven/swak-template)\nas a, well, template.\n\n## Documentation\nThe API documentation to `swak` is hosted on [GitHub Pages](https://yedivanseven.github.io/swak/).\n",
"bugtrack_url": null,
"license": null,
"summary": "Swiss army knife for functional data-science projects.",
"version": "0.1.5",
"project_urls": {
"Changelog": "https://github.com/yedivanseven/swak/blob/main/CHANGELOG.md",
"Documentation": "https://yedivanseven.github.io/swak/",
"Issues": "https://github.com/yedivanseven/swak/issues",
"Repository": "https://github.com/yedivanseven/swak.git"
},
"split_keywords": [
"functional",
" tools",
" utilities",
" helpers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "020ca58d67d1c8337bc3ef60cf54f0b3adb8952a174ff0e168b6d49b6496122c",
"md5": "de5a049d51b80ba31d863b41e4320197",
"sha256": "f180ce928e9973bc1b00556b94fabb5e34a08be9bdcfa72a137aade81122d78e"
},
"downloads": -1,
"filename": "swak-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de5a049d51b80ba31d863b41e4320197",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 131207,
"upload_time": "2024-10-23T14:55:48",
"upload_time_iso_8601": "2024-10-23T14:55:48.335048Z",
"url": "https://files.pythonhosted.org/packages/02/0c/a58d67d1c8337bc3ef60cf54f0b3adb8952a174ff0e168b6d49b6496122c/swak-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f229450629ea8c08dd43578760361fe20e2ed158b2c8897588be061e746552ad",
"md5": "718283226247669c2a8446cf108f3227",
"sha256": "a567a6b27909d473be3a7008d8c27364fc94f4710f6a1cc70c58d295602ecec6"
},
"downloads": -1,
"filename": "swak-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "718283226247669c2a8446cf108f3227",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 78070,
"upload_time": "2024-10-23T14:55:49",
"upload_time_iso_8601": "2024-10-23T14:55:49.712766Z",
"url": "https://files.pythonhosted.org/packages/f2/29/450629ea8c08dd43578760361fe20e2ed158b2c8897588be061e746552ad/swak-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 14:55:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yedivanseven",
"github_project": "swak",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "swak"
}
