# netts - NETworks of Transcript Semantics
[![GitHub release](https://img.shields.io/github/v/release/alan-turing-institute/netts?include_prereleases)](https://GitHub.com/alan-turing-institute/netts/releases/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/netts.svg)](https://pypi.python.org/pypi/netts/)
[![codecov](https://codecov.io/gh/alan-turing-institute/netts/branch/main/graph/badge.svg?token=58uMq5hbNt)](https://codecov.io/gh/alan-turing-institute/netts)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
Toolbox for constructing semantic speech networks from speech transcripts.
## About
The algorithms in this toolbox create a semantic speech graph from transcribed speech. Speech transcripts are short paragraphs of largely raw, uncleaned speech-like text. For example:
> 'I see a man and he is wearing a jacket. He is standing in the dark against a light post. On the picture there seems to be like a park and... Or trees but in those trees there are little balls of light reflections as well. I cannot see the... Anything else because it’s very dark. But the man on the picture seems to wear a hat and he seems to have a hoodie on as well. The picture is very mysterious, which I like about it, but for me I would like to understand more about the picture.'
> -- <cite>Example Transcript</cite>
Below is the semantic speech graph constructed from this text.
![Semantic speech graph example](https://github.com/alan-turing-institute/netts/raw/main/docs/docs/img/real_example_network_with_picture_transcript.png)
*Figure 1. Semantic Speech Graph. Nodes represents an entity mentioned by the speaker (e.g. I, man, jacket). Edges represent relations between nodes mentioned by the speaker (e.g. see, has on).*
## Getting started
Read the full documentation [here](https://alan-turing-institute.github.io/netts/).
### Where to get it
You can install the latest release from [PyPi](https://pypi.org/project/netts/)
```bash
pip install netts
```
or get the latest development version from GitHub (not stable)
```bash
pip install git+https://github.com/alan-turing-institute/netts
```
### Additional dependencies
Netts requires the Java Runtime Environment. Instructions for downloading and installing for your operating system can be found [here](https://docs.oracle.com/goldengate/1212/gg-winux/GDRAD/java.htm#BGBFHBEA).
Netts also requires a few additional dependencies to work which you can download with the netts CLI that was installed by pip
```bash
netts install
```
### Basic usage
The quickest way to process a transcript is with the CLI.
```bash
netts run transcript.txt outputs
```
where `transcript.txt` is a text file containing transcribed speech and `outputs` is the name of a directory to write the outputs to. Additional logging information can be found in `netts_log.log`.
## Contributors
Netts was written by [Caroline Nettekoven](https://www.caroline-nettekoven.com) in collaboration with [Sarah Morgan](https://semorgan.org).
Netts was packaged in collaboration with [Oscar Giles](https://www.turing.ac.uk/people/researchers/oscar-giles), [Iain Stenson](https://www.turing.ac.uk/research/research-engineering/meet-the-team) and [Helen Duncan](https://www.turing.ac.uk/people/research-engineering/helen-duncan).
<!-- ## Citing netts
If you use netts in your work, please cite this paper:
> Caroline R. Nettekoven, Kelly Diederen, Oscar Giles, Helen Duncan, Iain Stenson, Julianna Olah, Nigel Collier, Petra Vertes, Tom J. Spencer, Sarah E. Morgan, and Philip McGuire. 2021. “Networks of Transcript Semantics - Netts.” -->
Raw data
{
"_id": null,
"home_page": "https://github.com/alan-turing-institute/netts",
"name": "netts",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.11",
"maintainer_email": "",
"keywords": "NLP,networks,transcribed speech,semantic content,graph theory",
"author": "Caroline Nettekoven",
"author_email": "crn29@cantab.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/05/fa/d80a251a72ef99138fd664f2614f0d73a1b4dab78dc978833bbd04fed9c5/netts-0.3.2.tar.gz",
"platform": null,
"description": "# netts - NETworks of Transcript Semantics\n\n[![GitHub release](https://img.shields.io/github/v/release/alan-turing-institute/netts?include_prereleases)](https://GitHub.com/alan-turing-institute/netts/releases/)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/netts.svg)](https://pypi.python.org/pypi/netts/)\n[![codecov](https://codecov.io/gh/alan-turing-institute/netts/branch/main/graph/badge.svg?token=58uMq5hbNt)](https://codecov.io/gh/alan-turing-institute/netts)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n\nToolbox for constructing semantic speech networks from speech transcripts.\n\n## About\n\nThe algorithms in this toolbox create a semantic speech graph from transcribed speech. Speech transcripts are short paragraphs of largely raw, uncleaned speech-like text. For example:\n\n> 'I see a man and he is wearing a jacket. He is standing in the dark against a light post. On the picture there seems to be like a park and... Or trees but in those trees there are little balls of light reflections as well. I cannot see the... Anything else because it\u2019s very dark. But the man on the picture seems to wear a hat and he seems to have a hoodie on as well. The picture is very mysterious, which I like about it, but for me I would like to understand more about the picture.'\n> -- <cite>Example Transcript</cite>\n\nBelow is the semantic speech graph constructed from this text.\n\n![Semantic speech graph example](https://github.com/alan-turing-institute/netts/raw/main/docs/docs/img/real_example_network_with_picture_transcript.png)\n*Figure 1. Semantic Speech Graph. Nodes represents an entity mentioned by the speaker (e.g. I, man, jacket). Edges represent relations between nodes mentioned by the speaker (e.g. see, has on).*\n\n## Getting started\n\nRead the full documentation [here](https://alan-turing-institute.github.io/netts/).\n\n### Where to get it\n\nYou can install the latest release from [PyPi](https://pypi.org/project/netts/)\n\n```bash\npip install netts\n```\n\nor get the latest development version from GitHub (not stable)\n\n```bash\npip install git+https://github.com/alan-turing-institute/netts\n```\n\n### Additional dependencies\n\nNetts requires the Java Runtime Environment. Instructions for downloading and installing for your operating system can be found [here](https://docs.oracle.com/goldengate/1212/gg-winux/GDRAD/java.htm#BGBFHBEA).\n\nNetts also requires a few additional dependencies to work which you can download with the netts CLI that was installed by pip\n\n```bash\nnetts install\n```\n\n### Basic usage\n\nThe quickest way to process a transcript is with the CLI.\n\n```bash\nnetts run transcript.txt outputs\n```\n\nwhere `transcript.txt` is a text file containing transcribed speech and `outputs` is the name of a directory to write the outputs to. Additional logging information can be found in `netts_log.log`.\n\n## Contributors\n\nNetts was written by [Caroline Nettekoven](https://www.caroline-nettekoven.com) in collaboration with [Sarah Morgan](https://semorgan.org).\n\nNetts was packaged in collaboration with [Oscar Giles](https://www.turing.ac.uk/people/researchers/oscar-giles), [Iain Stenson](https://www.turing.ac.uk/research/research-engineering/meet-the-team) and [Helen Duncan](https://www.turing.ac.uk/people/research-engineering/helen-duncan).\n\n<!-- ## Citing netts\n\nIf you use netts in your work, please cite this paper:\n> Caroline R. Nettekoven, Kelly Diederen, Oscar Giles, Helen Duncan, Iain Stenson, Julianna Olah, Nigel Collier, Petra Vertes, Tom J. Spencer, Sarah E. Morgan, and Philip McGuire. 2021. \u201cNetworks of Transcript Semantics - Netts.\u201d -->\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later3",
"summary": "Toolbox for constructing NETworks of Transcript Semantics.",
"version": "0.3.2",
"split_keywords": [
"nlp",
"networks",
"transcribed speech",
"semantic content",
"graph theory"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f35f6e5862f9bd1dd2508bfc31b0fbe6b7df4e5fa870abb781bd0e22255d6ca",
"md5": "ecdc799ed39ffb3c97883655c0130b59",
"sha256": "1d614d92583065009342a04b7f167f46aedf879f0ca405b220dd47d7e4826936"
},
"downloads": -1,
"filename": "netts-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ecdc799ed39ffb3c97883655c0130b59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.11",
"size": 47182,
"upload_time": "2023-03-20T19:23:34",
"upload_time_iso_8601": "2023-03-20T19:23:34.988902Z",
"url": "https://files.pythonhosted.org/packages/0f/35/f6e5862f9bd1dd2508bfc31b0fbe6b7df4e5fa870abb781bd0e22255d6ca/netts-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05fad80a251a72ef99138fd664f2614f0d73a1b4dab78dc978833bbd04fed9c5",
"md5": "1b81c14200c413b84395e4d6b61978f8",
"sha256": "b7341ba32f42b2f053d1e83b8361f65ba3d23cb587b31d530786c9e236fc37e5"
},
"downloads": -1,
"filename": "netts-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "1b81c14200c413b84395e4d6b61978f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.11",
"size": 41996,
"upload_time": "2023-03-20T19:23:44",
"upload_time_iso_8601": "2023-03-20T19:23:44.156757Z",
"url": "https://files.pythonhosted.org/packages/05/fa/d80a251a72ef99138fd664f2614f0d73a1b4dab78dc978833bbd04fed9c5/netts-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-20 19:23:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "alan-turing-institute",
"github_project": "netts",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netts"
}