Skip to content

samueldobbie/markup

Repository files navigation

Markup Annotation Tool for ML and NLP

Markup is an online annotation tool that can be used to transform unstructured documents into structured formats for NLP and ML tasks, such as named-entity recognition. Markup learns as you annotate to predict and suggest complex annotations, and also provides integrated access to common and custom ontologies for concept mapping.

Key Features

  • Predictive annotation - Markup's machine learning-powered predictive annotation feature suggests complex annotations as you work, making the process of annotating documents more efficient and saving you valuable time.

  • Integrated ontology access Markup provides integrated access to a wide range of common ontologies (e.g. UMLS, SNOMED-CT, ICD-10), as well as the ability to upload custom ontologies, for concept mapping.

  • Predictive ontology mapping - Markup's predictive ontology mapping feature uses machine learning to suggest appropriate mappings to standard and custom terminologies based on the text you're annotating.

  • User-friendly interface - Whether you're a technical expert or a beginner, Markup's user-friendly interface makes it easy for anyone to start annotating documents with minimal setup.

Installation

To install and run Markup locally:

  1. Clone the repository and install dependencies, git clone https://github.com/samueldobbie/markup && cd markup && yarn install
  2. Install the Supabase CLI
  3. Start Supabase, supabase start. This will generate and output an API URL and anon key. Add both to the .env.local file
  4. Add an OpenAI API key to the .env.local file (Optional)
  5. Run the development server, yarn start
  6. Open Markup in your web browser, http://localhost:3000

Usage

To get started with Markup, read the quick start guide.

Contributions

Contributions to Markup are appreciated. If you'd like to contribute, please follow these guidelines:

  1. Fork the repository
  2. Create a new branch for your feature
  3. Make your changes
  4. Submit a pull request for review

Support

If you have any questions or need assistance with Markup, you can contact me at [email protected].