inceptalytics
An easy-to-use API for analyzing INCEpTION annotation projects.
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.2%) to scientific vocabulary
Keywords
Repository
An easy-to-use API for analyzing INCEpTION annotation projects.
Basic Info
Statistics
- Stars: 18
- Watchers: 6
- Forks: 8
- Open Issues: 12
- Releases: 4
Topics
Metadata Files
README.md
INCEpTALYTICS
An easy-to-use API for analyzing INCEpTION annotation projects. * We parse an XMI export of an Inception annotation project and provide easy access to (most) of the underlying data including annotators, source files, etc. * We provide recipes for computing project statistics, confusion matrices, inter-annotator-agreement, or plotting progress reports.
Installation
INCEpTALYTICS is on PyPi. To install it run:
bash
pip install inceptalytics
Basic Usage
```python from inceptalytics import Project
file = "data/ExampleProjectPOS.zip"
load project
project = Project.fromzippedxmi(file)
print all annotator names
for annotator in project.annotators: print(annotator)
create a view
pos_type = "de.tudarmstadt.ukp.dkpro.core.api.lexmorph.type.pos.POS"
view = project.select( annotation=project.featurepath(postype, "coarseValue"), annotators=project.annotators, sourcefiles=project.sourcefile_names )
print('# pos annotations in view:', len(view.annotations))
print('IAA Krippendorff: ', view.iaa()) ```
See the Documentation for further details.
Dashboard
We also provide a basic Streamlit web application as a starting point for a dashboard that fits your needs.
To run the dashboard, you will have to install some additional dependencies.
bash
pip install -r examples/streamlit_requirements.txt
Afterwards, you can run the dashboard.
bash
streamlit run examples/dashboard.py
The application should be available in your browser under http://localhost:8501. The URL is also printed on the shell.
Changelog
Version 0.1.0
- Project is now on PyPi.
- Projects can now be loaded using the INCEpTION's Remote API using
Project.from_remote. - Removed plotting functionality from INCEpTALYTICS and moved it to the dashboard under example.
Version 0.1.1
- Added sanity checks and input normalisation to
Project.from_remote. - Updated
Project.from_remoteto be compatible with the latest version of pycaprio.
Owner
- Name: catalpa-cl
- Login: catalpa-cl
- Kind: organization
- Repositories: 10
- Profile: https://github.com/catalpa-cl
Citation (CITATION.cff)
cff-version: 1.2.0 type: software message: "If you use this software in your research, please cite it as below." authors: - family-names: "Hamacher" given-names: "Marius" - family-names: "Zesch" given-names: "Torsten" title: "INCEpTALYTICS - An easy-to-use API for analyzing INCEpTION annotation projects." version: 0.1.1 doi: 10.5281/zenodo.5654690 date-released: 2022-09-20 url: "https://github.com/catalpa-cl/inceptalytics"
GitHub Events
Total
- Issues event: 1
- Watch event: 1
- Issue comment event: 1
Last Year
- Issues event: 1
- Watch event: 1
- Issue comment event: 1
Dependencies
- matplotlib *
- plotly *
- streamlit *
- watchdog *
- abatilo/actions-poetry v2 composite
- actions/cache v3 composite
- actions/checkout v3 composite
- actions/setup-python v3 composite
- peaceiris/actions-gh-pages v3 composite
- alabaster 0.7.13
- attrs 21.2.0
- babel 2.13.0
- beautifulsoup4 4.12.2
- certifi 2023.7.22
- charset-normalizer 3.3.0
- clarabel 0.6.0
- click 8.1.7
- colorama 0.4.6
- cvxopt 1.2.7
- cvxpy 1.4.0
- deprecation 2.1.0
- dkpro-cassis 0.8.0
- docutils 0.20.1
- ecos 2.0.12
- furo 2023.9.10
- idna 3.4
- imagesize 1.4.1
- importlib-metadata 6.8.0
- importlib-resources 5.4.0
- jinja2 3.1.2
- joblib 1.3.2
- krippendorff 0.6.1
- llvmlite 0.41.0
- lxml 4.9.3
- m2r2 0.3.3.post2
- markdown-it-py 3.0.0
- markupsafe 2.1.3
- mdurl 0.1.2
- mistune 0.8.4
- more-itertools 8.12.0
- numba 0.58.0
- numpy 1.25.2
- osqp 0.6.3
- packaging 23.2
- pandas 2.1.1
- pyannote-core 5.0.0
- pyannote-database 5.0.1
- pybind11 2.11.1
- pycaprio 0.2.1
- pygamma-agreement 0.5.6
- pygments 2.16.1
- pympi-ling 1.70.2
- python-dateutil 2.8.2
- pytz 2023.3.post1
- pyyaml 6.0.1
- qdldl 0.1.7.post0
- requests 2.31.0
- requests-toolbelt 0.9.1
- rich 13.6.0
- scikit-learn 1.3.1
- scipy 1.11.3
- scs 3.2.3
- shellingham 1.5.3
- six 1.16.0
- snowballstemmer 2.2.0
- sortedcontainers 2.4.0
- soupsieve 2.5
- sphinx 7.2.6
- sphinx-basic-ng 1.0.0b2
- sphinxcontrib-applehelp 1.0.7
- sphinxcontrib-devhelp 1.0.5
- sphinxcontrib-htmlhelp 2.0.4
- sphinxcontrib-jsmath 1.0.1
- sphinxcontrib-qthelp 1.0.6
- sphinxcontrib-serializinghtml 1.1.9
- textgrid 1.5
- threadpoolctl 3.2.0
- toposort 1.7
- tqdm 4.66.1
- typer 0.9.0
- typing-extensions 4.8.0
- tzdata 2023.3
- urllib3 1.26.17
- zipp 3.17.0
- furo ^2023.9.10 docs
- m2r2 ^0.3.3.post2 docs
- sphinx ^7.2.6 docs
- dkpro-cassis ^0.8.0
- krippendorff ^0.6.1
- pandas ^2.1.1
- pycaprio ^0.2.1
- pygamma-agreement ^0.5.6
- python >=3.9,<3.11
- scikit-learn ^1.3.1
- urllib3 ^1.26.15