Skip to main content

Build charachter graphs from text.

Project description

tex2net

Build Status PyPI version License Python Versions

Overview

tex2net is a Python library designed to convert narrative texts into interactive network graphs that visualize character interactions. The library leverages Natural Language Processing (NLP) with spaCy, text rewriting and summarization using Transformer models (T5), network analysis with NetworkX, and interactive visualization with Pyvis and Matplotlib. This tool is perfect for researchers, data scientists, and digital humanities scholars looking to explore complex narrative structures.

Features

  • Text Preprocessing & Entity Extraction: Extract characters from text using spaCy's Named Entity Recognition.
  • Graph Construction: Build directed graphs representing character interactions, annotated with actions and sentence IDs.
  • Node Merging: Combine nodes with similar character names for consistency.
  • Text Rewriting & Summarization: Use T5 models to rephrase or summarize text, emphasizing clear character-verb-character structures.
  • Network Analysis: Compute centrality measures, detect communities, analyze temporal relationships, and more.
  • Visualization: Create both static (Matplotlib) and interactive (Pyvis) visualizations for in-depth narrative analysis.

Installation

Install the package via pip:

pip install tex2net

Make sure you have all the required dependencies. You can also install them using the provided requirements.txt if needed. You may need to run:

pip install --upgrade typing_extensions
python -m spacy download en_core_web_lg

Usage Example

Below is an example of how to use tex2net to create a character graph from sample text:

import tex2net

# Sample text data (this could be text from a novel, article, or LaTeX file)
text_data = """
Alice was discussing ideas with Bob. Later, Bob met Charlie.
"""

# Create a character graph from the text data
graph, characters, relationships = tex2net.create_character_graph(text_data)

# Optionally, join similar nodes to merge duplicate character entries
joined_graph = tex2net.join_similar_nodes(graph, characters)

tex2net.visualize_directed_graph(joined_graph, title="Character Relationships Directed Graph")

For more complex text the create_character_graph_llm_chunked function can be used.

More functions are instantiated in example_usage.ipynb.

Contributing

Contributions are welcome! Feel free to submit pull requests or open issues to improve the functionality of this library. Please follow the code style and add tests for any new features.

License

This project is licensed under the GPL-3.0 License.


Happy storytelling and network exploring!

Citation

If you find tex2net helpful in your academic or professional work, please cite the following paper:

graphql Copy @inproceedings{aparicio2023tex2net, title={tex2net: A Package for Storytelling Using Network Models}, author={Aparicio, Joao Tiago and Arsenio, Elisabete and Henriques, Rui}, booktitle={Proceedings of the 41st ACM International Conference on Design of Communication}, pages={119--125}, year={2023} }

or

Aparicio, J. T., Arsenio, E., & Henriques, R. (2023, October). tex2net: A Package for Storytelling Using Network Models. In Proceedings of the 41st ACM International Conference on Design of Communication (pp. 119-125).

You can find the paper at ACM Digital Library: https://dl.acm.org/doi/pdf/10.1145/3615335.3623022.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tex2net-1.30.tar.gz (24.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tex2net-1.30-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

Details for the file tex2net-1.30.tar.gz.

File metadata

  • Download URL: tex2net-1.30.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.16

File hashes

Hashes for tex2net-1.30.tar.gz
Algorithm Hash digest
SHA256 797e1850b2a9fc04725ef7e4aa9aa3d326abff9f51c1d11ae1ed685e90679734
MD5 09cff667ec628b8e4cc88310928e5cb1
BLAKE2b-256 ef22f75fa90f288a0519cb9614f4a7372f2da499cae7bab4bdb5794c8e8f6026

See more details on using hashes here.

File details

Details for the file tex2net-1.30-py3-none-any.whl.

File metadata

  • Download URL: tex2net-1.30-py3-none-any.whl
  • Upload date:
  • Size: 24.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.16

File hashes

Hashes for tex2net-1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 ae0e9b8ac47c02cc5c53414e3889b1b8704d8604c481ce086708800189015086
MD5 32b9fbc67ff8abd541a02f794abc2a94
BLAKE2b-256 83ced17bbfc2905cd5e207b7af95843a1987539ab7035fae0b18cac07f7e5d95

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page