Metadata-Version: 2.1
Name: DeepSaki
Version: 1.0.1
Summary: DeepSaki is an add-on to TensorFlow. It provides a variaty of custom classes ranging from activation functions to entire models, helper functions to facilitate connectiong to your, compute HW and many more!
Author-email: Sascha Kirch <susch130993@googlemail.com>
Maintainer-email: Sascha Kirch <susch130993@googlemail.com>
License: MIT License
        
        Copyright (c) [2023] [Sascha Kirch]
        
        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.
        
Project-URL: Homepage, https://sascha-kirch.github.io/
Project-URL: Documentation, https://sascha-kirch.github.io/DeepSaki
Project-URL: Repository, https://github.com/sascha-kirch/DeepSaki
Project-URL: Changelog, https://sascha-kirch.github.io/DeepSaki/latest/CHANGELOG/
Keywords: deeplearning,machinelearning,tensorflow,TPU
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tensorflow>=2.8
Requires-Dist: numpy>=1.21.6
Requires-Dist: tensorflow_addons>=0.21.0
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: pydot
Requires-Dist: opencv-contrib-python
Requires-Dist: einops

<p align="center">
 <img src="assets/images/ds_logo.png"  alt="deepsaki-logo" width = 80% >
</p>

![Python](https://img.shields.io/badge/python-3.10+-blue)
![GitHub](https://img.shields.io/github/license/sascha-kirch/deepsaki)

**Main-Branch:**<br>
[![Build](https://github.com/sascha-kirch/DeepSaki/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sascha-kirch/DeepSaki/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/sascha-kirch/DeepSaki/branch/main/graph/badge.svg?token=FD7IE1T9EO)](https://codecov.io/gh/sascha-kirch/DeepSaki)
[![Documentation](https://img.shields.io/badge/ref-Documentation-blue)](https://sascha-kirch.github.io/DeepSaki/latest/)

**Develop-Branch:**<br>
[![Build](https://github.com/sascha-kirch/DeepSaki/actions/workflows/test.yml/badge.svg?branch=develop)](https://github.com/sascha-kirch/DeepSaki/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/sascha-kirch/DeepSaki/branch/develop/graph/badge.svg?token=FD7IE1T9EO)](https://codecov.io/gh/sascha-kirch/DeepSaki)
[![Documentation](https://img.shields.io/badge/ref-Documentation-blue)](https://sascha-kirch.github.io/DeepSaki/develop/)

## :rocket: DeepSaki

DeepSaki is an add-on to [TensorFlow](https://github.com/tensorflow/tensorflow). It provides a variaty of custom classes ranging from activation functions to entire models, helper functions to facilitate connectiong to your, compute HW and many more!

The project started as fun project to learn and to collect the code snippets I was using in my projects. Now it has been transformed into a modern SW package featuring CI/CD and a documentation. 

**:medal_military: Some highlights:**

- Layers to transform data into the frequency domain using FFTs, like [FFT2D](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/layers/#DeepSaki.layers.fourier_layer.FFT2D) and [FFT3D](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/layers/#DeepSaki.layers.fourier_layer.FFT3D).
- Layers to perform calculations in the frequency domain supporting complex values like [FourierPooling2D](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/layers/#DeepSaki.layers.fourier_layer.FourierPooling2D).
- Wrapper to make [initializer](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/initializers/#DeepSaki.initializers.initializer_helper.make_initializer_complex) and [activation functions](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/activations/#DeepSaki.activations.complex_valued_activations.ComplexActivation) complex-valued.
- Utilities to [auto-detect your compute hardware](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/utils/#DeepSaki.utils.environment.detect_accelerator).
- autoencoder like models like the [UNet](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/models/#DeepSaki.models.autoencoders.UNet) and discriminator models like a [Layout-Content-Discriminator](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/models/#DeepSaki.models.discriminators.LayoutContentDiscriminator).
- [Augmentations](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/augmentations/) like Cut-Mix and Cut-Out
- [Custom constraints](https://sascha-kirch.github.io/DeepSaki/latest/reference/DeepSaki/constraints/) for your layers like NonNegative.
- And many more...
 
**:watch: Coming soon:**

- A CycleGAN framework as used in [VoloGAN](https://arxiv.org/abs/2207.09204)
- A diffusion model framework as used in [RGB-D-Fusion](https://ieeexplore.ieee.org/document/10239167)
- Further support for complex valued deep learning



## :hammer_and_wrench: Installation

### Using git
```bash
git clone https://github.com/sascha-kirch/DeepSaki.git
cd DeepSaki
pip install .
```

### Using pip
![PyPI](https://img.shields.io/pypi/v/deepsaki)
![PyPI - Status](https://img.shields.io/pypi/status/deepsaki)
```
pip install DeepSaki
```

## :handshake: Contribute to DeepSaki
I highly encourage you to contribute to DeepSaki. Checkout our [contribution guide](https://sascha-kirch.github.io/DeepSaki/latest/CONTRIBUTE/) to get started. 

## :star: Star History
[![Star History Chart](https://api.star-history.com/svg?repos=sascha-kirch/DeepSaki&type=Date)](https://star-history.com/#sascha-kirch/DeepSaki&Date)
