-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
3,078 additions
and
1,692 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,74 @@ | ||
| <div align='center'> | ||
| <img src="https://raw.githubusercontent.com/alexandrainst/AIAI/main/gfx/aiai-logo.png" width="auto" height="224"> | ||
| </div> | ||
| # AlexandraAI | ||
|
|
||
| ### A Python package for Danish data science | ||
| ##### _(pronounced as in "Aye aye captain")_ | ||
|
|
||
| ______________________________________________________________________ | ||
| [](https://pypi.org/project/aiai/) | ||
| [](https://alexandrainst.github.io/AIAI/aiai.html) | ||
| [](https://github.com/alexandrainst/aiai/blob/main/LICENSE) | ||
| [](https://github.com/alexandrainst/aiai/commits/main) | ||
| [](https://github.com/alexandrainst/aiai/tree/main/tests) | ||
|
|
||
| [](https://pypi.org/project/alexandra_ai/) | ||
| [](https://alexandrainst.github.io/AlexandraAI/alexandra_ai.html) | ||
| [](https://github.com/alexandrainst/AlexandraAI/blob/main/LICENSE) | ||
| [](https://github.com/alexandrainst/AlexandraAI/commits/main) | ||
| [](https://github.com/alexandrainst/AlexandraAI/tree/main/tests) | ||
|
|
||
| ## Installation | ||
|
|
||
| To install the package simply write the following command in your favorite terminal: | ||
|
|
||
| ``` | ||
| $ pip install aiai | ||
| 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> | ||
| evaluate --model-id <model_id> --task <task> | ||
| ``` | ||
|
|
||
| Here `model_id` is the HuggingFace model ID, which can be found on the [HuggingFace | ||
| Hub](https://huggingface.co/models), 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 | ||
| evaluate --help | ||
| ``` | ||
|
|
||
| The specific model version to use can also be added after the suffix '@': | ||
|
|
||
| ``` | ||
| $ evaluate --model_id <model_id>@<commit> | ||
| 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 | ||
| 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 | ||
| 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 aiai import Evaluator | ||
| >>> 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 | ||
|
|
@@ -72,27 +78,21 @@ check out all the ways you can contribute to this package. :sparkles: | |
|
|
||
| - _Your name here?_ :tada: | ||
|
|
||
|
|
||
| ## Maintainers | ||
|
|
||
| The following are the core maintainers of the `aiai` package: | ||
| The following are the core maintainers of the `alexandra_ai` package: | ||
|
|
||
| - [@saattrupdan](https://github.com/saattrupdan) (Dan Saattrup Nielsen; [email protected]) | ||
| - [@AJDERS](https://github.com/AJDERS) (Anders Jess Pedersen; [email protected]) | ||
|
|
||
| ## The AlexandraAI ecosystem | ||
|
|
||
| ## The AIAI ecosystem | ||
|
|
||
| This package is a wrapper around several AIAI packages, each of which is standalone: | ||
|
|
||
| - [AIAI-eval](https://github.com/alexandrainst/AIAI-eval): Evaluation of finetuned models. | ||
| - [AIAI-train](https://github.com/alexandrainst/AIAI-train): Finetuning machine learning models. | ||
| - [AIAI-deploy](https://github.com/alexandrainst/AIAI-deploy): Deployment and monitoring of machine learning models. | ||
| - [AIAI-data](https://github.com/alexandrainst/AIAI-data): Accessing external data sources. | ||
| - [AIAI-anon](https://github.com/alexandrainst/AIAI-anon): Anonymization and pseudonymization of texts. | ||
| This package is a wrapper around other AlexandraAI packages, each of which is standalone: | ||
|
|
||
| - [AlexandraAI-eval](https://github.com/alexandrainst/AlexandraAI-eval): Evaluation of finetuned models. | ||
|
|
||
| ## Project structure | ||
|
|
||
| ``` | ||
| . | ||
| ├── .flake8 | ||
|
|
@@ -108,13 +108,12 @@ This package is a wrapper around several AIAI packages, each of which is standal | |
| ├── LICENSE | ||
| ├── README.md | ||
| ├── gfx | ||
| │ └── aiai-logo.png | ||
| ├── makefile | ||
| ├── notebooks | ||
| ├── poetry.toml | ||
| ├── pyproject.toml | ||
| ├── src | ||
| │ ├── aiai | ||
| │ ├── alexandra_ai | ||
| │ │ └── __init__.py | ||
| │ └── scripts | ||
| │ ├── fix_dot_env_file.py | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.