Commit bf9f515e authored by Gmodena's avatar Gmodena
Browse files

Update documentation.

parent 3d6820b6
Pipeline #1732 passed with stages
in 52 seconds
# ImageMatching
Image recommendation for unillustrated Wikipedia articles
Image recommendation for unillustrated Wikipedia articles.
This repo is a refactoring of https://github.com/mirrys/ImageMatching. It was developed for the [Image Suggestion](https://phabricator.wikimedia.org/project/view/5098/) proof of concept.
# Installation
The package is published to a local `pypi` index at https://gitlab.wikimedia.org/api/v4/projects/40/packages/pypi/simple
You can install it at the command line with `pip`
``` shell
pip install algorunner --extra-index-url https://gitlab.wikimedia.org/api/v4/projects/40/packages/pypi/simple
```
Or add it as a `requirement.txt` dependency with:
```
-i https://gitlab.wikimedia.org/api/v4/projects/40/packages/pypi/simple
algorunner
```
## Getting started
......@@ -8,16 +25,11 @@ Connect to stat1005 through ssh (the remote machine that will host your notebook
ssh stat1005.eqiad.wmnet
```
### Installation
``` shell
pip install algorunner --extra-index-url https://gitlab.wikimedia.org/api/v4/projects/40/packages/pypi/simple
```
### Build from source
First, clone the repository
```shell
git clone https://github.com/clarakosi/ImageMatching.git
git clone git@gitlab.wikimedia.org:repos/generated-data-platform/ImageMatching.git
```
Setup and activate the virtual environment
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment