diff --git a/README.md b/README.md index addad2dd..82fc4a05 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@

- +

GenieNLP

-Build Status +Build Status PyPI Downloads Github Stars

@@ -14,11 +14,14 @@ GenieNLP is suitable for all NLP tasks, including text generation (e.g. translation, paraphasing), token classification (e.g. named entity recognition) and sequence classification (e.g. NLI, sentiment analysis). + This library contains the code to run NLP models for the [Genie Toolkit](https://github.com/stanford-oval/genie-toolkit) and the [Genie Virtual Assistant](https://genie.stanford.edu/). Genie primarily uses this library for semantic parsing, paraphrasing, translation, and dialogue state tracking. Therefore, GenieNLP has a lot of extra features for these tasks. -## Table of Contents -- [Table of Contents](#table-of-contents) +Works with [🤗 models](https://huggingface.co/models) and [🤗 Datasets](https://huggingface.co/datasets). + +## Table of Contents + - [Installation](#installation) - [Usage](#usage) - [Training a semantic parser](#training-a-semantic-parser) @@ -43,7 +46,7 @@ Or from source: ```bash git clone https://github.com/stanford-oval/genienlp.git cd genienlp -pip install -e . +pip install -e . # -e means your changes to the code will automatically take effect without the need to reinstall ``` After installation, `genienlp` command becomes available.