AlexandraAI
A Python package for Danish data science
Installation
To install the package simply write the following command in your favorite terminal:
pip install alexandra-ai
Quickstart
Benchmarking from the Command Line
The easiest way to benchmark pretrained models is via the command line interface. After having installed the package, you can benchmark your favorite model like so:
evaluate --model-id <model_id> --task <task>
Here model_id is the HuggingFace model ID, which can be found on the HuggingFace
Hub, and task is the task you want to benchmark the
model on, such as "ner" for named entity recognition. See all options by typing
evaluate --help
The specific model version to use can also be added after the suffix '@':
evaluate --model_id <model_id>@<commit>
It can be a branch name, a tag name, or a commit id. It defaults to 'main' for latest.
Multiple models and tasks can be specified by just attaching multiple arguments. Here is an example with two models:
evaluate --model_id <model_id1> --model_id <model_id2> --task ner
See all the arguments and options available for the evaluate command by typing
evaluate --help
Benchmarking from a Script
In a script, the syntax is similar to the command line interface. You simply initialise
an object of the Evaluator class, and call this evaluate object with your favorite
models and/or datasets:
>>> from alexandra_ai import Evaluator
>>> evaluator = Evaluator()
>>> evaluator('<model_id>', '<task>')
Contributors
If you feel like this package is missing a crucial feature, if you encounter a bug or if you just want to correct a typo in this readme file, then we urge you to join the community! Have a look at the CONTRIBUTING.md file, where you can check out all the ways you can contribute to this package. ✨
- Your name here? 🎉
Maintainers
The following are the core maintainers of the alexandra_ai package:
- @saattrupdan (Dan Saattrup Nielsen; saattrupdan@alexandra.dk)
- @AJDERS (Anders Jess Pedersen; anders.j.pedersen@alexandra.dk)
The AlexandraAI ecosystem
This package is a wrapper around other AlexandraAI packages, each of which is standalone:
- AlexandraAI-eval: Evaluation of finetuned models.
Project structure
.
├── .flake8
├── .github
│ └── workflows
│ ├── ci.yaml
│ └── docs.yaml
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── gfx
├── makefile
├── notebooks
├── poetry.toml
├── pyproject.toml
├── src
│ ├── alexandra_ai
│ │ └── __init__.py
│ └── scripts
│ ├── fix_dot_env_file.py
│ └── versioning.py
└── tests
└── __init__.py
Metadata
Release files for alexandra-ai 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| alexandra-ai-0.1.0.tar.gz | 4.5 kB | Without provenance | Details for alexandra-ai-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| alexandra_ai-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for alexandra_ai-0.1.0-py3-none-any.whl |
Total release size: 8.5 kB
Release files / alexandra-ai-0.1.0.tar.gz
| Download URL | alexandra-ai-0.1.0.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b8e51dd0ee7391c31ffc6f8f578d7bbe047192b51651c82369195f3eaf2bc00
|
|
BLAKE2b-256 checksum How to use checksums |
ffdbf688ad74091a1015fd643a502d4c569c94cf257e3560878f73693dd24072
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.0 CPython/3.10.10 Darwin/21.6.0
|
Release files / alexandra_ai-0.1.0-py3-none-any.whl
| Download URL | alexandra_ai-0.1.0-py3-none-any.whl |
|---|---|
| Size | 4.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b1c1f2d2ed1a5bc35989ef6728eb12d5f5450aa8be98c647b91fca27e7507c98
|
|
BLAKE2b-256 checksum How to use checksums |
7022acdc7240450ca167513de7995623858914318e61452f159a89603148198a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.0 CPython/3.10.10 Darwin/21.6.0
|
Security for alexandra-ai 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.