From 581d0aa583af6bebe06df34ac86a215fdac414c7 Mon Sep 17 00:00:00 2001 From: "John (Juan) Lema" Date: Fri, 30 Jul 2021 18:55:10 -0700 Subject: [PATCH] Added release requirements Added source copyright headers Added CONTRIBUTING.md --- CONTRIBUTING.md | 14 + README.md | 38 +- SUPPORT.md | 25 - development/index.html | 5 + frontend/MainContainer.tsx | 3 + frontend/actions.ts | 3 + frontend/api.ts | 3 + frontend/app.css | 5 + frontend/components/InteractiveText.tsx | 3 + .../components/PerspectiveScoresBarChart.tsx | 3 + .../PerspectiveScoresSpiderChart.tsx | 3 + frontend/components/TextDetailedAnalysis.tsx | 3 + frontend/components/TextGenerationControl.tsx | 3 + frontend/components/TextGenerationResults.tsx | 3 + frontend/index.tsx | 3 + frontend/models/AnalyzedText.ts | 3 + frontend/models/TextRecord.ts | 3 + frontend/reducers.ts | 3 + package-lock.json | 17957 +++++++++++++++- setup.py | 11 +- transformerviz/__init__.py | 3 + transformerviz/assets/__init__.py | 3 + transformerviz/assets/index.html | 5 + transformerviz/helpers/__init__.py | 3 + transformerviz/helpers/utils.py | 3 + transformerviz/server.py | 3 + webpack.config.js | 3 + 27 files changed, 18041 insertions(+), 76 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 SUPPORT.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ebf23ac --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing + +This project welcomes contributions and suggestions. Most contributions require you to +agree to a Contributor License Agreement (CLA) declaring that you have the right to, +and actually do, grant us the rights to use your contribution. For details, visit +https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need +to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the +instructions provided by the bot. You will only need to do this once across all repositories using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. diff --git a/README.md b/README.md index 1c9cd73..64453f3 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,20 @@ -# Project +# Transformer Visualizations +Investigations on Transformer Visualizations by the Aether Prototyping and Incubation team. -> This repo has been populated by an initial template to help get you started. Please -> make sure to update the content to build a great experience for community-building. +## Getting Started -As the maintainer of this project, please make a few updates: +### Development Environment Setup +- `python -m pip install --upgrade pip` +- `pip install -r requirements.txt --cache-dir ` (The `cache-dir` parameter is optional). +- `pip install -e .` +- `npm install` +- `npm run build` -- Improving this README.MD file to provide a great experience -- Updating SUPPORT.MD with content about this project's support experience -- Understanding the security reporting process in SECURITY.MD -- Remove this section from the README +### Running + `PERSPECTIVE_API_KEY= GPT2_MODEL_VERSION= NUM_RETURN_SEQUENCES= TRANSFORMERS_CACHE= FLASK_APP=transformerviz/server.py flask run --host 0.0.0.0 --port 5000` (The `TRANSFORMERS_CACHE` environment variable is optional). +- Point your browser to port 5000 of the server on which the app is running. ## Contributing - This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. @@ -25,25 +28,8 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft. contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. ## Trademarks - This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies. - - -## Development Environment Setup - -- `pip install pip upgrade` -- `pip install -r requirements.txt --cache-dir ` (The `cache-dir` parameter is optional). -- `pip install -e .` -- `npm install` -- `npm run build` - - -## Running - -- `PERSPECTIVE_API_KEY= GPT2_MODEL_VERSION= NUM_RETURN_SEQUENCES= TRANSFORMERS_CACHE= FLASK_APP=transformerviz/server.py flask run --host 0.0.0.0 --port 5000` (The `TRANSFORMERS_CACHE` environment variable is optional). -- Point your browser to port 5000 of the server on which the app is running. - diff --git a/SUPPORT.md b/SUPPORT.md deleted file mode 100644 index dc72f0e..0000000 --- a/SUPPORT.md +++ /dev/null @@ -1,25 +0,0 @@ -# TODO: The maintainer of this repo has not yet edited this file - -**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project? - -- **No CSS support:** Fill out this template with information about how to file issues and get help. -- **Yes CSS support:** Fill out an intake form at [aka.ms/spot](https://aka.ms/spot). CSS will work with/help you to determine next steps. More details also available at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). -- **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide. - -*Then remove this first heading from this SUPPORT.MD file before publishing your repo.* - -# Support - -## How to file issues and get help - -This project uses GitHub Issues to track bugs and feature requests. Please search the existing -issues before filing new issues to avoid duplicates. For new issues, file your bug or -feature request as a new Issue. - -For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE -FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER -CHANNEL. WHERE WILL YOU HELP PEOPLE?**. - -## Microsoft Support Policy - -Support for this **PROJECT or PRODUCT** is limited to the resources listed above. diff --git a/development/index.html b/development/index.html index 1c39224..8d7090d 100644 --- a/development/index.html +++ b/development/index.html @@ -1,3 +1,8 @@ + +