Merge pull request #519 from ServiceNow/main

Release 2.6.0

Author: gabegma

.app_env

@@ -3,4 +3,5 @@ BACKEND_VERSION=latest
 FRONTEND_VERSION=latest
 DEVICE=cpu
 STAGE=production
-CFG_PATH=/config/examples/clinc_oos/conf.json
+CFG_PATH=
+LOAD_CONFIG_HISTORY=

.dockerignore

@@ -1,9 +1,8 @@
-azimuth_shr/local_files
-azimuth_shr/files
-azimuth_shr/sentence_transformers
-azimuth_shr/tfhub
+azimuth_shr
 cache
+config
 dist
+docs
 .coverage*
 
 # Must be kept in sync with webapp/.dockerignore

.github/workflows/docker_cd.yml

@@ -4,7 +4,7 @@ on:
     tags:
       - "v*"
 jobs:
-  docker-deploy:
+  docker-deploy-cpu:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -16,11 +16,28 @@ jobs:
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - run: |
-         make DEVICE=gpu build push
-         make DEVICE=cpu build push
-         make TAG=$VERSION DEVICE=gpu build push
-         make TAG=$VERSION DEVICE=cpu build push
+      - name: Build and push CPU Docker image
+        run: |
+          make DEVICE=cpu build push
+          make DEVICE=cpu TAG=$VERSION build push
+        env:
+          VERSION: ${{ steps.get_version.outputs.VERSION }}
+  docker-deploy-gpu:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Get the version
+        id: get_version
+        run: echo VERSION=${GITHUB_REF/refs\/tags\//} >> $GITHUB_OUTPUT
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push GPU Docker image
+        run: |
+          make DEVICE=gpu build push
+          make DEVICE=gpu TAG=$VERSION build push
         env:
           VERSION: ${{ steps.get_version.outputs.VERSION }}
 

.pre-commit-config.yaml

@@ -52,7 +52,7 @@ repos:
         entry: poetry run flake8
         types: [ python ]
   - repo: https://github.com/pycqa/isort
-    rev: 5.8.0
+    rev: 5.12.0
     hooks:
       - id: isort
         name: isort
@@ -63,6 +63,6 @@ repos:
         name: mypy
         language: system
         verbose: true
-        entry: bash -c 'poetry run mypy "azimuth" || true' --
+        entry: poetry run mypy azimuth
         files: azimuth
         pass_filenames: false

CHANGELOG.md

@@ -11,7 +11,6 @@ Released changes are shown in the
 ## [Not released]
 
 ### Added
-- Persistent id.
 
 ### Changed
 

CITATION.cff

@@ -1,24 +1,59 @@
-cff-version: 1.0.0
+cff-version: 1.2.0
 message: "If you use Azimuth in your projects, please cite it as below."
 authors:
-- family-names: "Branchaud-Charron"
-  given-names: "Frederic"
-- family-names: "Gauthier-Melancon"
-  given-names: "Gabrielle"
-- family-names: "Marinier"
-  given-names: "Joseph"
-- family-names: "Brin"
-  given-names: "Lindsay"
-- family-names: "Tyler"
-  given-names: "Chris"
-- family-names: "Le"
-  given-names: "Di"
-- family-names: "Grande"
-  given-names: "Karine"
-- family-names: "Babu"
-  given-names: "Nandhini"
+- family-names: Branchaud-Charron
+  given-names: Frederic
+- family-names: Gauthier-Melancon
+  given-names: Gabrielle
+- family-names: Marinier
+  given-names: Joseph
+- family-names: Brin
+  given-names: Lindsay
+- family-names: Tyler
+  given-names: Chris
+- family-names: Le
+  given-names: Di
+- family-names: Grande
+  given-names: Karine
+- family-names: Babu
+  given-names: Nandhini
 title: "Azimuth, an open-source dataset and error analysis tool for text classification"
 version: 2.5
-doi: 10.5281/zenodo.6511558
 date-released: 2022-08-17
-url: "https://github.com/ServiceNow/azimuth"
+url: "https://servicenow.github.io/azimuth"
+repository-code: "https://github.com/ServiceNow/azimuth"
+license: Apache-2.0
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.6511558
+preferred-citation:
+  type: conference-paper
+  title: "Azimuth: Systematic Error Analysis for Text Classification"
+  authors:
+  - family-names: Gauthier-Melancon
+    given-names: Gabrielle
+  - family-names: Marquez-Ayala
+    given-names: Orlando
+  - family-names: Brin
+    given-names: Lindsay
+  - family-names: Tyler
+    given-names: Chris
+  - family-names: Branchaud-Charron
+    given-names: Frederic
+  - family-names: Marinier
+    given-names: Joseph
+  - family-names: Grande
+    given-names: Karine
+  - family-names: Le
+    given-names: Di
+  collection-title: "Proceedings of the 2022 Conference on Empirical Methods in Natural Language Processing: System Demonstrations"
+  collection-type: proceedings
+  month: 12
+  year: 2022
+  publisher:
+    name: "Association for Computational Linguistics"
+  url: "https://aclanthology.org/2022.emnlp-demos.30/"
+  identifiers:
+  - type: other
+    value: "arXiv:2212.08216"
+    description: "The arXiv preprint of the paper"

Dockerfile

@@ -26,7 +26,7 @@ RUN apt-get update && \
     DEBIAN_FRONTEND=noninteractive apt-get install -y curl gcc make && \
     rm -rf /var/lib/apt/lists/*
 
-RUN curl -sSL https://install.python-poetry.org | python - --version 1.2.0 \
+RUN curl -sSL https://install.python-poetry.org | python - --version 1.4.0 \
     && ln -sf /usr/local/poetry/bin/poetry /usr/local/bin/poetry
 
 # Install dependencies.
@@ -39,6 +39,8 @@ RUN poetry config virtualenvs.create false && \
 # Install the project.
 COPY . /app/
 RUN poetry install --extras ${DEVICE} --no-interaction --no-ansi $(/usr/bin/test $STAGE == production && echo "--no-dev")
-ENV CFG_PATH="/config/nlp_sa/conf.json"
-ENV PORT=8091
-CMD ["sh","-c","umask 0002; python runner.py ${CFG_PATH} --port ${PORT}"]
+ENV CFG_PATH=
+ENV LOAD_CONFIG_HISTORY=
+ENV PORT=
+ENV ARTIFACT_PATH=/cache
+CMD ["sh","-c","umask 0002; python runner.py ${CFG_PATH} ${LOAD_CONFIG_HISTORY:+--load-config-history} ${PORT:+--port ${PORT}}"]

Makefile

@@ -31,7 +31,6 @@ include makefiles/Makefile.security
 include makefiles/Makefile.test
 include makefiles/Makefile.local
 include makefiles/Makefile.demo
-include makefiles/Makefile.docs
 
 .PHONY: build
 build: build_be build_fe
@@ -56,7 +55,7 @@ compose: build launch
 
 .PHONY: launch
 launch:
-	docker-compose -f docker-compose.yml $(COMPOSE_EXT) --env-file $(ENV_FILE) up
+	docker compose -f docker-compose.yml $(COMPOSE_EXT) --env-file $(ENV_FILE) up
 
 .PHONY: push
 push:

README.md

@@ -8,11 +8,15 @@
   <a href="https://servicenow.github.io/azimuth">
     <img alt="Documentation" src="https://github.com/ServiceNow/azimuth/actions/workflows/docs_cd.yml/badge.svg"/></a>
   <a href="https://join.slack.com/t/azimuth-org/shared_invite/zt-1i9eu48n9-7NnCXHw5VzUs~gs20xHxyg">
-    <img alt="Slack" src="https://img.shields.io/badge/slack-chat-green.svg?logo=slack"/></a>
+    <img alt="Slack" src="https://img.shields.io/badge/slack-chat-blue.svg?logo=slack"/></a>
   <a href="./LICENSE">
     <img alt="Licence" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
   <a href="https://doi.org/10.5281/zenodo.6511558">
     <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.6511558.svg" alt="DOI"></a>
+  <a href="https://arxiv.org/abs/2212.08216">
+    <img src="https://img.shields.io/badge/arXiv-2212.08216-blue.svg" alt="arXiv"></a>
+  <a href="https://azimuth-demo.net/">
+    <img alt="Azimuth" src="https://shields.io/badge/Azimuth-demo-blue?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAAAFBlWElmTU0AKgAAAAgAAgESAAMAAAABAAEAAIdpAAQAAAABAAAAJgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAMKADAAQAAAABAAAAMAAAAADJ6kISAAABWWlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iWE1QIENvcmUgNi4wLjAiPgogICA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyI+CiAgICAgICAgIDx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgoZXuEHAAAJHklEQVRoBe2YfWzW1RXHz7339/QVSovl7WmrjNcJCKIuumxxmzFGApsmbMSEbCxQQJDpmNkYmiVsuhD+cMtEXkoLLErYAnPqJDL+kC0xTiHghgzCO2jbh0KBtqvQl+f3u3ef2/KU0pa+uC3757nN6e/+7j3n3O85555z7+8RSbe0B9IeSHsg7YG0B9Ie+P95QP1PlnZOyU7RUndQt+kvuNfKd8SKUu6/vd5/ZoAHuulMXobJLYlsNMYpNQbExaAsFLGDxenMdsAuKeIalZLLVqlqZdVZLfZ0UrtPpaq4XlYp+3kNG7gBHvTGC8OMiR4QJQ8D7AERNQ4AQyDv8QhqhVqgEPLNQN4YT77v+GvE0LMEZR/9d6PIvS9PFicGGqX+G7DKaSlJjNdWngDwbCXuToB4+WpR7ghePYxpJ5T3sERXlA2utuqwRSLnJBbLjDmXA+ChLrJxpfQ4LJiCHXdhcwlPg6JT6HpLObc9mV90WOYo74g+W/8M2FBZFAR6IQDmo5EFpRLaI069E2n5SPLqzsucyd7rN7VYeeJeZHLC6lHvd9smZQdiYkcMN4FMw4hHEZwBjYVqccK2MArXy+LbT9+ksIeX3g3Y4Yypr55BWFchew97+BSZuNVKtJO9e6YbqM4LlFcVa6d2IXObETuzdWHJx52nb+q35dL5Eq3cY8S0FFB3QccZfjHKr9vZk3NS8rc2oCyRo408Q91YQYg1W2ZzaGJrZf6IMynh3p56U/UKwK+Gx6+xLhoSf6Zf28JH2+hFbMelyOUgvC5Mhqtl6R11Pa3XswHbLucFzU2/wANPwXCK6rIyqhq1C4+nkrInXTfGyj4dG2jzDtvHJ3YzlKOt/WZyccm+G0y99Mi3oKj6607UGrjuwYHbozB4VpaMvNhVqr1Odx7F80FT088B/wOG9yvtnohK42/2GzxCgQ7mAX4CibqOPPklQ4VW68Xi931/GmU1XFi8l9LsC8afobkmCF+S9Z8UdBW/2QAs19o9heXLYPyQBJ2fXFB8qKtQr+9bzk8C+Dwid8KG5rVIR6/D/wGlcnagR3ylV9mukyRxFEaLfLHwRgSxYKXsOJLRme0mA4KS8w+z8E/Zu2e1JQILio53Zu6zT9iCyPlKdTsnU4UsGXVOSkuuAGA9mZDrRC+RrWez+tTTmWFJSTVO+CFDB4nqMtOQP7vz9A0DyhKFzrrnmcymcv8suTj+UWfG/vRjmxN34/25LPSxDe32lEzkmnbR/ws0yySzvpEa7/eztOQUxWQl/E3of07Ka76Qku0wQBvHfpMHCfXvoiH1b6QY+v2k5FqnFsE/EtokeK5DdvHYBrbABt4DUXapvFqT2zHXz06YiO/lkCtToqYEYhekxNoN2FAzHOA+9Be0lld6q7spwa7PoD5xP9ViDkD3s/d3dp2PMvUexjw9YpqtP7gG1nxiB7EKn1tOublSUemvL213F+Fe8xAT08S5N5NV8YElrddCYhHaJ+nli7Mbeip38r2RVzlh18MTcvVYKmWnfYkdWPNnkJPfQ6O1NTO9sJZVjrDKLPpJFnidcjngm2HQMOSrnNaPE4H3qBpvtaHyd6fORIKHpuWvzL0Nfc2Y7G+18Q3wn3LK66/jEjhT1l0cFMiImmIG7idxj0VO/b2bPg9iWG2OZDXnZUSxAqvcULw9lGgVUFXwoh1M2fX3GP/MMxnBr6S8mlKX4NaprueYs9QkbiEZLTirCA8a59yKoLx6LPoa2NcNYlUdzyvahVdataoTndkggwuvdT29uZcfQ/FB1rs7FoQTAg6ISQSimNK5TRbFLwkHGXG5wziZxF6boiQxEebRYs3ISNl8+j4BY3gcEeoNiK63VnoTGfL8lieR9PPXm0IrFl9/a4F3MrOT8Wj7EBnKexgpc82IqxebvCAN5z9R5YkTzPzTOHukNcg6JwuGNTL2AU58yGo3PUDnZFRkQdd0RdVy9PjtNBVct11XfY33ywCtARAXMneB6/BFa+WSaBfB8yzAhrP4T4y1B0QFVrQNmbPKekxIaG8r0VDKANFYZcaRB79myoB/DaY2YVkh/WFw+yoGtT3vRMG3vY8ipeuNbT3qyqt2E32CjTZwBjzHwOx9tRBv+EOmjsUOcYXYD9sh7fSpZGBrxMXqpbKwiRzpuA+ZTYnZAIkjv8s2ui32RyVNyPfddrgDpj7hP4iWsXVa7KL42o7EoxxLbW2237KxMBhptR1D8KaC8Esong7eFzC0hb7/Ph2jTEXVHwDM6ebOMLAlEPd2a6OclL7AcC8xsdgfkbuPhHo8LC1+t2/kNzgyyiunRqJ348V/haGe0XZq35ju3nv5ZKbk5lB9fL45f+WeTAz2BRjSdsFiK621paN+0wqa7tLdR0xgHkPRg9D2MK/hve4cvY+0lhYfDjYnXiPKK3QQfZcIvNCrxNPjvdePw3fcVCQuso22QoFi3y9m67zEJNVAXlXKvpHMyjkmc4c2YmHPxnDwmZj9EwomwDErXFT0t14Xv9Xk5uqJxspuP83FcUavdy9O71hzOJ7vzFnk4PdxXAl4VyshNCY7dx4DP0aPP9088KOAIyHVP/jWPRnq0F8Lrsi15quCJ/hYWUoGvcIe3hDlxZ/uWurg7XfT5VXPs69fRN+asCr+nEw6GsilQbkSy8wPVBRn749TVk+jIt6HUr6jpQCqwrMvW52xESNoHDJScWG0VtFMAD9KekxndAREyW37haEORbUsRCWSWoB/maz338Yb2YIf0m8SFTVRWAmzTop1IcGzPKn4vkJQElJVSCzf9yaTNbKZySbiXL/VcnR9Bu2F8pEaia7hAPNgfWFh51D1uCSCdI9VHIaV8ZP+0G03gJmO5pNlUF6RCe1Epy11Wr7I3GgY8YYMpT8I8nlD/nTUdbrAaf9JxS/m+ymi29b8GeDX888UtU3wDxn/K4T//UiuwnQFq3GWPgfg45TjI5G4Y/KZq+xaXLobkFKZevro/PZcprRmAjwcEguCAq7dBZRivKOHOGXz2Gq5IMoBQJZzmlPYeQMNcNv1g4Z3AKqQA6GVt2ZmmnAfXucHL6v8aVyndFSXDH0ZjzVIU7JRlhfDd4s8TOFLP9MeSHsg7YG0B9IeSHsg7YHP74F/A3MLvD0hrV0DAAAAAElFTkSuQmCC"/></a>
 
   <br>
   <br>
@@ -37,7 +41,7 @@ Play with Azimuth on CLINC-OOS and a DistilBert model with a [live demo](https:/
 
 ### Published Paper at [EMNLP](https://2022.emnlp.org/)
 
-Our paper was accepted as a [system demo at EMNLP 2022](https://www.servicenow.com/research/publication/gabrielle-gauthier-melancon-azim-emnlp2022.html). More information will be available soon. 
+Our paper was accepted as a [system demo at EMNLP 2022](https://www.servicenow.com/research/publication/gabrielle-gauthier-melancon-azim-emnlp2022.html). It is available [here](https://arxiv.org/abs/2212.08216).
 
 ### Documentation
 
@@ -54,15 +58,15 @@ references to use Azimuth.
   different **contracts** which allow **configuring** Azimuth with different datasets and pipelines.
 * [Development](https://servicenow.github.io/azimuth/development) guides on how to develop and
   **contribute** to the repo.
-  
+
 ### YouTube Playlist
 
 <p align="center">
   <a href="https://www.youtube.com/playlist?list=PLdq4WQvLzJCnJmInRYBSfeCWLiHbX55V8">
     <img src="docs/docs/_static/images/youtube.png" width="560" height="315" />
   </a>
 </p>
-  
+
 ## Run Our Demo
 
 After installing the requirements, as explained

azimuth/__init__.py

@@ -1,12 +1,14 @@
+import os
 from pathlib import Path
 
-from datasets import set_progress_bar_enabled
+from datasets import disable_progress_bar
 from datasets.utils.logging import set_verbosity_error
 
 from azimuth.utils.logs import set_logger_config
 
 PROJECT_ROOT = str(Path(__file__).parent)
 
 set_verbosity_error()
-set_progress_bar_enabled(False)
+disable_progress_bar()
 set_logger_config()
+os.environ["TF_CPP_MIN_LOG_LEVEL"] = "1"  # INFO messages from TensorFlow are not printed