Giter Club home page Giter Club logo

edie's Introduction

ELEXIS Dictionary Evaluator (EDiE)

This is a tool for evaluating the quality and availability of dictionaries pubilshed using the ELEXIS dictionary API

For more information, please visit https://elex.is/

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/elexis-eu/edie.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/elexis-eu/edie.git)

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Getting Started

You can run the system using the command:

python src/main.py

Usage

usage: ELEXIS Dictionary Evaluation Tool (EDiE) [-h] [--server] [-d D [D ...]] [-e E] [-m M [M ...]] [--max-entries MAX_ENTRIES] [--api-key API_KEY]

options:
  -h, --help            show this help message and exit
  --server              Start in server mode
  -d D [D ...]          Dictionaries to evaluate
  -e E                  Endpoint to query
  -m M [M ...]          List of metrics to evaluate
  --max-entries MAX_ENTRIES
                        Maximum number of entries to evaluate
  --api-key API_KEY     The API KEY to use

You can test an endpoint with the following command, this is limited to a single endpoint:

python src/main.py -e http://lexonomy.elex.is --api-key ASK_SOMEONE_IN_THE_PROJECT \
   --max-entries=10 -d elexis-dsl-ddo --html tmp.html

There is also a docker image available to start in server mode.

docker pull acdhtech/elexis-edie
docker run -d -p 5000:5000  acdhtech/elexis-edie

Author

edie's People

Contributors

jmccrae avatar lenkab avatar sbyim avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

edie's Issues

Support for TEI

This issue tracks the implementation of TEI support in the service.

Refactor main code to make it testable

The main method is a long script and it isn't really suited for unit tests.

we should decompose the method, and maybe encapsulate it in a class.

It will also increase the readability of the code

Visualization

Visualization could help to compare different dictionaries based on the evaluation metrics

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.