Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/centre-for-humanities-computing/glove-semantic-explorer

Embedding explorer over arbitrary data using GloVe embeddings.

https://github.com/centre-for-humanities-computing/glove-semantic-explorer

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Embedding explorer over arbitrary data using GloVe embeddings.

Basic Info
  • Host: GitHub
  • Owner: centre-for-humanities-computing
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 9.77 KB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme License

README.md

glove-semantic-explorer

Set up embedding explorer on a corpus with GloVe word embeddings with an easy-to-use CLI.

Installation

You can install the CLI from PyPI:

We recommend that you use a Linux/Unix system, preferably Debian when using this tool. Windows and MacOS could still work, but we do not guarrantee this.

bash pip install glove-semantic-explorer

Usage

1. Train a model

You will need a corpus in the format of a bunch of .txt files in a folder. Every line in a file should represent one sentence/passage.

To train a GloVe model on the corpus, run:

bash python3 -m glove_semantic_explorer train_model dat/ -o model/glove.kv

This will output a keyed vectors file to model/glove.kv.

2. Run the Explorer

To run the explorer on the trained model locally, run:

bash python3 -m glove_semantic_explorer run_explorer -m model/glove.kv --port 8080

This will start embedding-explorer on the trained embedding model on port 8080.

3. Deploy!

You can deploy the application using docker compose. The way this can be done with our CLI is by auto-generating a Dockerfile, a compose.yaml and a main.py file, that contains all the code for running the server.

To output this into a folder called deployment/, run the following command:

bash python3 -m glove_semantic_explorer generate_docker "your_project_name" -m model/glove.kv -p 8080 -o deployment/

Beware that the model file only gets mounted to the container, and thus should not be removed, moved or renamed.

To deploy the app with docker compose run the following:

bash cd deployment/ sudo docker compose up

The app will then run on port 8080.

Owner

  • Name: Center for Humanities Computing Aarhus
  • Login: centre-for-humanities-computing
  • Kind: organization
  • Email: chcaa@cas.au.dk
  • Location: Aarhus, Denmark

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

pyproject.toml pypi
  • embedding_explorer ^0.5.2
  • gensim ^4.2.0
  • glovpy ^0.1.0
  • python ^3.9
  • radicli ^0.0.24