Skip to content

usnistgov/summerAnnotune

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 

Repository files navigation

Annotune

Annotune (Annotation, Text Understanding, and Navigation Engine) is a powerful tool designed to streamline the annotation process of documents. It leverages advanced machine learning models for topic modeling, allowing users to annotate documents faster and more efficiently. Annotune groups documents into clusters and keywords, providing better context understanding and enhancing the annotation process.

Features

  • Fast Annotation: Speed up the annotation process using advanced machine learning models.
  • Topic Modeling: Group documents into clusters based on topics for better context understanding.
  • Keyword Extraction: Extract and highlight key phrases from documents.
  • Interactive Interface: User-friendly interface with navigation icons, suggestion buttons, and explanation tooltips.
  • Automated Label Suggestions: Receive label suggestions generated by machine learning models.
  • Manual Label Entry: Option to manually enter and submit labels.
  • Timer and Robot Animation: Visual indication of the annotation process with a timer and robot animation.

Getting Started

Prerequisites

  • Python 3.8 or higher
  • Django 3.2 or higher
  • Required Python libraries listed in requirements.txt

Installation

  1. Clone the repository:

    git clone https://github.com/usnistgov/summerAnnotune.git
    cd annotune
  2. Create a virtual environment:

    python -m venv venv
  3. Activate the virtual environment:

    • On Windows:

      venv\Scripts\activate
    • On macOS/Linux:

      source venv/bin/activate
  4. Install dependencies:

    pip install -r requirements.txt
  5. Run migrations:

    python manage.py migrate
  6. Start the development server:

    python manage.py runserver
  7. Access the application:

    Open your web browser and navigate to http://127.0.0.1:8000/.

Usage

  1. Upload Documents: Upload the documents you wish to annotate.
  2. Annotate: Use the suggested labels or manually enter labels.
  3. Navigation: Navigate through documents using the previous and next buttons.
  4. Timer and Animation: The timer and running robot provide visual feedback during the annotation process.

Screenshots

Screenshot 1 Screenshot 2

File Structure

annotune/
├── annotune/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   ├── wsgi.py
│   └── asgi.py
├── documents/
│   ├── migrations/
│   ├── templates/
│   ├── static/
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── tests.py
│   ├── urls.py
│   ├── views.py
│   └── ...
├── static/
│   ├── css/
│   ├── images/
│   └── javascript/
├── templates/
│   ├── base.html
│   ├── index.html
│   └── ...
├── manage.py
└── requirements.txt

Contributing

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b feature-branch
  3. Commit your changes:

    git commit -m "Description of changes"
  4. Push to the branch:

    git push origin feature-branch
  5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Thanks to all contributors and the open-source community.
  • Special thanks to the developers of the Django framework and other dependencies.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published