A webserver for hosting scorer models.
Project description
[](https://travis-ci.org/wikimedia/ores) [](https://codecov.io/gh/wikimedia/ores)
Objective Revision Evaluation Service
A webserver for hosting scoring services. For more information, see [the ORES documentation on MediaWiki](https://mediawiki.org/wiki/ORES).
Installation
ORES is based on Python 3. Use pip to install ORES:
pip install ores (or pip3 install ores if your distribution defaults to Python 2)
If you’re running with the default Redis configuration, you’ll need to install a few more optional libraries,
pip install ores[redis]
Then you can easily run a test server by:
ores applications.wsgi
Use the -h argument to view its usage.
ores applications.wsgi -h
Visit these pages to see if your installation works,
http://localhost:8080/ http://localhost:8080/v2/scores/testwiki/revid/641962088?features=true
Running ores using docker composer
As an easy way to run ores for development, download and install [docker-compose](https://docs.docker.com/compose/) and then do:
docker-compose up
ores will be accessible through localhost:8080
Running a development server
We recommend that you set up a python “virtual environment”. We put together [this guide](https://gist.github.com/halfak/9f4830895496af9e9731) to help you get everything set up.
Install requirements AND the test-requirements in order to run the default test server and experiment with different scoring strategies.
$ pip install -r requirements.txt
$ pip install -r test-requirements.txt
Run a test server as ORES using the ./utility, so local changes are reflected: Use -h to view its usage
$ ./utility applications.wsgi
Check if everything is running on http://localhost:8080.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ores-1.3.1.tar.gz.
File metadata
- Download URL: ores-1.3.1.tar.gz
- Upload date:
- Size: 121.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bac057d109dc370be512c7b4ee37d0e58cb8fbda3110b095182c4de91a3cca0b |
|
| MD5 | b21a8336b9632b7d83a89c241a982363 |
|
| BLAKE2b-256 | 8287ef26fc192098c403c15227091d71a95127698294508c2f14a28ce0fe674d |
File details
Details for the file ores-1.3.1-py2.py3-none-any.whl.
File metadata
- Download URL: ores-1.3.1-py2.py3-none-any.whl
- Upload date:
- Size: 922.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7220e84e13786a38858a907d491f38896a87590ee14bbbf942f41d93db13f2db |
|
| MD5 | 4930f3cd8777e70119a44f67f1683c5a |
|
| BLAKE2b-256 | 97f40ea3e3206e3bbc136ba0a0acd9dd7c70cde311c6d711571e72ebe39d26e8 |
](https://travis-ci.org/wikimedia/ores){kind=link}
](https://codecov.io/gh/wikimedia/ores){kind=link}