gliff.ai ANNOTATE
👋 Welcome in! 👋
This repository contains the Open Source code for gliff.ai’s ANNOTATE product.
ANNOTATE aims to allow domain experts to easily and efficiently annotate multidimensional images - embedding their knowledge - for the purposes of developing imaging AI products. ANNOTATE is just one part of gliff.ai’s growing privacy-preserving MLOps (Machine Learning Operations) platform. When the full gliff.ai platform is used, ANNOTATE provides just one step in developing high-quality and auditable datasets that satisfy any relevant regulatory frameworks which enables our users to build world-changing and trustworthy AI models and products.
A preview build of the current main branch is here. Built from the annotate/examples folder on the main branch.
✅ We welcome contributions on this repository! ✅
Table of Contents
Looking for something specific? 🔍
- Repository Introduction
- Table of Contents
- Installation
- Development
- Linting and Formatting
- Testing
- Contribute
- Contact
- License
Installation
Run npm install @gliff-ai/annotate in your command line to install the package from the npm registry.
Development
Frontend code should always be written in Typescript and transpiled using the options in tsconfig.json in this repository. npm should always be used for package management.
npm run serve will run a local webpack developer server for quick access.
Linting and Formatting
As a standard, all code contributions should be linted with ESLint using .eslintrc.js and formatted with Prettier. Note: HTML + CSS, mark-up and mark-down code are exemptions and should be formatted using Prettier but do not need to be linted.
npm run lint will lint the codebase.
Our GitHub Actions will also lint any pull requests before they're merged.
Testing
All code contributions should be tested using both the Jest and React Testing Library.
npm run test will run any existing tests in our codebase.
Our GitHub Actions will also test any pull requests before they're merged! These all must pass and have 2 reviewers approval before a pull request can merge. If one or a few fail and your troubleshooting is not giving an answer, please check out the gliff.ai Contribution Guide 👋 for further guidance.
Continuous Integration
GitHub Actions should only be included under the .github/workflows path.
Contribute
We welcome all contributors and any contributions on this project through the likes of feedback on or suggesting features and enhancements, raising bug problems, reporting on security vulnerabilities, reviewing code, requesting or creating tests, user testing etc. to ensure gliff.ai can help enable the best and biggest positive impact possible.
Sounds good and want to contribute to the project? 🧑💻 \ Please check the gliff.ai Contribution Guide 👋 before you get started. Don’t forget the gliff.ai Code of Conduct ⚠️ and gliff.ai Security Policy 🔒 too!
A big thank you from the entire gliff.ai team to these fellow contributors (emoji key): \ {{Contributor List - coming soon}}
Contact
Need some help? 🤔 Have a question? 🧠 \ Reach out to the gliff.ai team at community@gliff.ai or on our GitHub discussions.
License
This code is licensed under a GNU AGPLv3 license 📝 \ Curious about our reasoning for this? Read about them here!