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.

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.22.tar.gz (24.5 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.22-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tex2net-1.22.tar.gz
Algorithm Hash digest
SHA256 268486a9ec649318d41cb2869c0fd786a66c43b90e12192c0359705652617e7e
MD5 b268f6afbd4bfed4a2d696e603507a8f
BLAKE2b-256 08b7acf516f6ab6da72a85d36e027b274cec86ce28326c253056518b00e44795

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tex2net-1.22-py3-none-any.whl
  • Upload date:
  • Size: 24.2 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.22-py3-none-any.whl
Algorithm Hash digest
SHA256 b5693a65e766e0eddb08df50fedb955f58241cb54b5489b86de5983119e2885f
MD5 17edd4a5199d5631834823118d1fa258
BLAKE2b-256 6560752f1060ce6dbd28aa2aeb580c4dd7de60398c64b39913009f7f7a7e3467

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