Metadata-Version: 2.1
Name: armory-library
Version: 23.10.1
Summary: TwoSix Armory Adversarial Robustness Evaluation Library
Project-URL: Homepage, https://github.com/twosixlabs/armory-library
Project-URL: BugTracker, https://github.com/twosixlabs/armory-library/issues
Project-URL: Documentation, https://armory-library.readthedocs.io/en/latest/
Author-email: Two Six Technologies <armory@twosixtech.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.8
Requires-Dist: adversarial-robustness-toolbox==1.15.1
Requires-Dist: boto3
Requires-Dist: botocore
Requires-Dist: ffmpeg-python
Requires-Dist: lightning
Requires-Dist: loguru
Requires-Dist: matplotlib
Requires-Dist: mlflow
Requires-Dist: numpy
Requires-Dist: opencv-python-headless==4.5.5.62
Requires-Dist: opencv-python==4.5.5.62
Requires-Dist: pandas
Requires-Dist: pillow
Requires-Dist: pydub
Requires-Dist: requests
Requires-Dist: scikit-learn<1.2.0
Requires-Dist: scipy
Requires-Dist: setuptools-scm
Requires-Dist: tensorboardx
Requires-Dist: tensorflow>=2.11.0
Requires-Dist: tf-models-official
Requires-Dist: tidecv
Requires-Dist: torch>=2.0.0
Requires-Dist: torchaudio>=2.0.1
Requires-Dist: torchvision>=0.15.1
Requires-Dist: transformers
Provides-Extra: all
Requires-Dist: charmory[developer]; extra == 'all'
Requires-Dist: charmory[documentation]; extra == 'all'
Provides-Extra: developer
Requires-Dist: bandit[toml]; extra == 'developer'
Requires-Dist: black[jupyter]; extra == 'developer'
Requires-Dist: flake8; extra == 'developer'
Requires-Dist: hatch; extra == 'developer'
Requires-Dist: ipywidgets; extra == 'developer'
Requires-Dist: isort; extra == 'developer'
Requires-Dist: pre-commit; extra == 'developer'
Requires-Dist: pytest; extra == 'developer'
Requires-Dist: wheel; extra == 'developer'
Provides-Extra: documentation
Requires-Dist: mkdocs; extra == 'documentation'
Requires-Dist: mkdocs-exclude; extra == 'documentation'
Requires-Dist: mkdocs-material; extra == 'documentation'
Requires-Dist: mkdocstrings; extra == 'documentation'
Provides-Extra: extras
Requires-Dist: apache-beam>=2.22.0; extra == 'extras'
Requires-Dist: google-cloud-storage; extra == 'extras'
Requires-Dist: librosa; extra == 'extras'
Requires-Dist: protobuf; extra == 'extras'
Requires-Dist: python-levenshtein; extra == 'extras'
Requires-Dist: sox; extra == 'extras'
Requires-Dist: tensorflow-datasets!=4.9.0,>=4.6.0; extra == 'extras'
Requires-Dist: torchmetrics<0.8.0; extra == 'extras'
Requires-Dist: transformers; extra == 'extras'
Description-Content-Type: text/markdown

![charmory logo](docs/assets/charmory.png)

---

[![CI][ci-badge]][ci-url]
[![PyPI Status Badge][pypi-badge]][pypi-url]
[![PyPI - Python Version][python-badge]][python-url]
[![License: MIT][license-badge]][license-url]
[![Docs][docs-badge]][docs-url]
[![Code style: black][style-badge]][style-url]
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7561756.svg)](https://doi.org/10.5281/zenodo.7561756)


# Overview

Charmory is the temporary name for the JATIC armory replacement. This name is
mostly for the use of the developers as we move function and code from Armory to
Charmory. Interim releases will be provided under this scaffolding name, although
most users will still `import armory` as there is no Python package "charmory".



# Installation & Configuration

```bash
pip install charmory
```

Will make the `armory` namespace available to your Python environment. In the open-source
version, the installation name was "armory-testbed" which provided also provided
the `armory` namespace.

## Conda
```bash
conda env create -f environment.yaml -n charmory
conda activate charmory
```


# Usage
See the documentation [here](https://jatic.pages.jatic.net/twosix/armory/).

# Acknowledgment
This material is based upon work supported by the Defense Advanced Research Projects
Agency (DARPA) under Contract No. HR001120C0114. Any opinions, findings and
conclusions or recommendations expressed in this material are those of the author(s)
and do not necessarily reflect the views of the Defense Advanced Research Projects
Agency (DARPA).

# Points of Contact
POC: Matt Wartell @matt.wartell
DPOC: Christopher Woodall @christopher.woodall


<!-- TODO: repoint to JATIC CI or drop the badges -->

<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[ci-badge]: https://github.com/twosixlabs/armory/workflows/GitHub%20CI/badge.svg
[ci-url]: https://github.com/twosixlabs/armory/actions/
[pypi-badge]: https://badge.fury.io/py/armory-testbed.svg
[pypi-url]: https://pypi.org/project/armory-testbed
[python-badge]: https://img.shields.io/pypi/pyversions/armory-testbed
[python-url]: https://pypi.org/project/armory-testbed
[license-badge]: https://img.shields.io/badge/License-MIT-yellow.svg
[license-url]: https://opensource.org/licenses/MIT
[docs-badge]: https://readthedocs.org/projects/armory/badge/
[docs-url]: https://readthedocs.org/projects/armory/
[style-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[style-url]: https://github.com/ambv/black
