Contribute a model¶
This page describes how to contribute a model to the European Language Grid. You can describe a model and upload its contents at ELG or include in its description a link to the location it can be accessed from.
0. Before you start¶
1. Prepare the content files (for ELG hosted resources)¶
If you wish to upload the model at ELG, you must package it in a compressed format (currently as a .zip, .tar or .gz file).
2. Describe and register the model at ELG¶
You can register the item (i.e., the metadata record and, optionally, the content files)
using the ELG interactive editor (see Use the interactive editor), or
To upload the content files for the model, you can follow the procedure described here.
The following figure gives an overview of the metadata elements you must provide 1 for a model, replicating the editor (with sections horizontally and tabs vertically) so that you can easily track each element. In the editor, all elements, mandatory or not, are explained by definitions and examples.
To describe any resource efficiently you need to name it, provide a description with a few words about it and indicate its version 2. Then, one or more keywords are asked for the resource and an email or a landing page for anyone who wishes to have additional information about it.
For models, you must also specify the intended application (e.g. whether it can be used for Machine Translation, Named Entity Recognition, Text Categorization, etc.), the model function (e.g. zero-shot classification), and model type (e.g. embeddings, Bayesian model, n-gram model, etc.). If you describe an n-gram model, you will also be required to supply information for the base item and order.
You also have to describe independently each distributable form of the model (i.e. all the ways the user can obtain it, e.g., in a downloadable form, or accessed through a data service). For each distribution, you must always specify the licence under which it is made available. In case you decide not to upload the content files at ELG, you must also include a link to the point it can be accessed from (download / access location 3 ).
Finally, you need to add the language(s) and, if multilingual, multilinguality type and, for each distributable form, the distribution features (size and data format).
3. Manage and submit for publication¶
Through the My items page you can access your metadata record (see Manage your items) and edit it until you are satisfied. You can then submit it for publication, in line with the publication lifecycle defined for ELG metadata records.
At this stage, the metadata record can no longer be edited and is only visible to you and to us, the ELG platform administrators.
Before it is published, your submission undergoes a validation process, which is described in detail at CHAPTER 4: VALIDATING ITEMS.
Once approved, it will appear on the ELG catalogue and you will receive a notification email.
You must fill in at least the mandatory elements for the metadata record to be saved. In addition, you may be required to fill in specific mandatory if applicable elements (indicated in the figure with an asterisk), depending on the values you provide for other elements.
If no version number is provided, the system will automatically number it as “1.0.0” with an indication that it has been automatically assigned. We recommend, however, the use of Semantic Versioning (https://semver.org/) for labelling versions.
The two elements differ in terms of the actions that a consumer has to undertake in order to access the resource. Use download location to provide a direct link to the content files; no actions are required on behalf of the user who can simply download the file(s). Access location is typically a page with some text, which includes a button or a link for accessing or downloading the resource itself; the user must read through the text on the page in order to find the link.