Merge pull request #23 from twosixlabs/readme-citation-updates

updated README and CITATION for armory-library

.github/workflows/release.yml

@@ -2,20 +2,12 @@
 name: 🎁 Armory Release Workflow
 
 on:
-  repository_dispatch:
-    types: build-and-release
-
-  workflow_dispatch:
-    inputs:
-      test:
-        type: boolean
-        description: publish to pypi test server
-        required: true
-        default: true
-
+    push:
+        tags:
+          - 'v[0-9]+.[0-9]+.[0-9]+'
 jobs:
   release-wheel:
-    name: 🛞 Build release wheel
+    name: 🛞 Publish release wheel to PyPI
     runs-on: ubuntu-latest
     steps:
       - name: 🐍 Setup Python 3.10

CITATION.cff

@@ -2,31 +2,40 @@
 # Visit https://bit.ly/cffinit to generate yours today!
 
 cff-version: 1.2.0
-title: armory
+title: armory-library
 message: >-
   If you use this software, please cite it using the
   metadata from this file.
 type: software
 authors:
-  - given-names: David
-    family-names: Slater
+  - given-names: Matt
+    family-names: Wartell
     email: armory@twosixtech.com
-  - given-names: Lucas
-    family-names: Cadalzo
+  - given-names: Kyle
+    family-names: Treubig
     email: armory@twosixtech.com
-repository-code: 'https://github.com/twosixlabs/armory'
-url: 'https://www.gardproject.org/'
+  - given-names: Sterling
+    family-names: Suggs
+    email: armory@twosixtech.com
+repository-code: 'https://github.com/twosixlabs/armory-library'
+url: 'https://www.armory-library.org/'
 abstract: >-
-  Armory is a testbed for running scalable evaluations of
-  adversarial defenses for ML systems. Configuration files
-  are used to launch local or cloud instances of the Armory
-  docker containers. Models, datasets, and evaluation
-  scripts can be pulled from external repositories or from
-  the baselines within this project.
+  Armory-library is a library for evaluating adversarial
+  attack machine learning models. It is a pure Python
+  installable which is intended to be used in a user created
+  application. The armory-library API is intentionally small
+  and simple to afford "today" speed of integration.
+  Armory-library uses PyTorch, Lightning.AI, and IBM's
+  Adversarial Robustness Toolbox (ART) to effect its
+  evaluations; it logs all pararmeters and metrics to MLFlow
+  either locally or to a remote server.
+
+
+  Armory-library is part of the Armory project.
 keywords:
   - adversarial machine learning
 license: MIT
-commit: 029b811eef05167f33d393720ad193f307b1161a
-version: 0.16.4
-doi: 10.5281/zenodo.7561755
-date-released: '2023-01-20'
+commit: 1ab0924b6eeca7720b26d66289686b37e81c9830
+version: 23.10.4
+date-released: '2023-10-25'
+doi: 10.5281/zenodo.10041830

README.md

@@ -8,37 +8,32 @@
 [![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)
-
+[![DOI](https://zenodo.org/badge/673882087.svg)](https://zenodo.org/doi/10.5281/zenodo.10041829)
 
 # 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".
+Charmory is a scaffolding name as we rework code coming from the `armory.` namespace.
+It is slated to be renamed to `armory` once we adapt all legacy code that needs
+to be adapted. We expect the `charmory.` namespace to be disappear by the end of 2023.
+
+Presently, working use of armory-library, as shown in the `examples/` directory
+imports symbols from both `armory` and `charmory` namespaces. Soon a global substitution
+in user code from `charmory` to simply `armory` will be needed. We'll announce
+in the release notes when this is needed.
 
 
 
 # Installation & Configuration
 
 ```bash
-pip install charmory
+pip install armory-library
 ```
 
-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
-```
+Will make the `armory` and `charmory` namespaces available to your Python environment.
 
 
 # Usage
-See the documentation [here](https://jatic.pages.jatic.net/twosix/armory/).
+See the documentation in the [armory-library docs](https://armory-library.readthedocs.io/en/latest/).
 
 # Acknowledgment
 This material is based upon work supported by the Defense Advanced Research Projects
@@ -47,12 +42,7 @@ conclusions or recommendations expressed in this material are those of the autho
 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-library/actions/workflows/ci.yml/badge.svg