Skip to content

Commit

Permalink
updated readme w. cit info
Browse files Browse the repository at this point in the history
  • Loading branch information
KennethEnevoldsen committed Dec 5, 2021
1 parent f9e5459 commit f0dcae1
Showing 1 changed file with 10 additions and 62 deletions.
72 changes: 10 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,77 +55,25 @@ asent.visualize(doc)

| Type | |
| ------------------------------ | ---------------------- |
| 🚨 **FAQ** | [FAQ] |
| 🚨 **Bug Reports** | [GitHub Issue Tracker] |
| 🎁 **Feature Requests & Ideas** | [GitHub Issue Tracker] |
| 👩‍💻 **Usage Questions** | [GitHub Discussions] |
| 🗯 **General Discussion** | [GitHub Discussions] |


[FAQ]: https://kennethenevoldsen.github.io/augmenty/faq.html
[github issue tracker]: https://github.com/kennethenevoldsen/asent/issues
[github discussions]: https://github.com/kennethenevoldsen/asent/discussions

## 🎓 Citing asent

If you use this library in your research, please cite it using:

# FAQ


<details>
<summary>How do I test the code and run the test suite?</summary>


asent comes with an extensive test suite. In order to run the tests, you'll usually want to clone the repository and build asent from the source. This will also install the required development dependencies and test utilities defined in the requirements.txt.


```
pip install -r requirements.txt
pip install pytest
python -m pytest
```

which will run all the test in the `asent/tests` folder.

Specific tests can be run using:

```
python -m pytest augmenty/tests/desired_test.py
```

**Code Coverage**
If you want to check code coverage you can run the following:
```
pip install pytest-cov
python -m pytest --cov=.
```


</details>


<br />



<br />

<details>
<summary>How is the documentation generated?</summary>

asent uses [sphinx](https://www.sphinx-doc.org/en/master/index.html) to generate documentation. It uses the [Furo](https://github.com/pradyunsg/furo) theme with a custom styling.

To make the documentation you can run:

```
# install sphinx, themes and extensions
pip install sphinx furo sphinx-copybutton sphinxext-opengraph
# generate html from documentations
make -C docs html
```

</details>


<br />
@inproceedings{asent2021,
title={Asent: Fast, flexible and transparent sentiment analysis},
author={Enevoldsen, Kenneth and Hansen, Lasse},
year={2021}
}
```

0 comments on commit f0dcae1

Please sign in to comment.