From 37d5dd236e56023742c1a0de862d50ac389045cf Mon Sep 17 00:00:00 2001
From: Jacques Fize <jacques.fize@insa-lyon.fr>
Date: Thu, 15 Oct 2020 13:17:29 +0200
Subject: [PATCH] debug table in README
---
README.md | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index f015b7b..f402d35 100644
--- a/README.md
+++ b/README.md
@@ -44,11 +44,12 @@ For Anaconda users
## Get pre-trained model
Pre-trained model are available :
-| Geographic Area | Description | URL |
-|-----------------|-------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
-| FR | Model trained on the France populated places and area | [Download](https://projet.liris.cnrs.fr/hextgeo/files/trained_models/FR_MODEL_2.zip) |
-| GB | Model trained on the England populated places and area | [Download](https://projet.liris.cnrs.fr/hextgeo/files/trained_models/GB_MODEL_2.zip) |
-| US | Model trained on the United States of America populated places and area | [Download](https://projet.liris.cnrs.fr/hextgeo/files/trained_models/US_MODEL_2.zip) |
+
+| Geographic Area | Description | URL |
+|-----------|-------------------------------------------------------------------------|--------------------------------------------------------------------------|
+| FR | Model trained on the France populated places and area | https://projet.liris.cnrs.fr/hextgeo/files/trained_models/FR_MODEL_2.zip |
+| GB | Model trained on the England populated places and area | https://projet.liris.cnrs.fr/hextgeo/files/trained_models/GB_MODEL_2.zip |
+| US | Model trained on the United States of America populated places and area | https://projet.liris.cnrs.fr/hextgeo/files/trained_models/US_MODEL_2.zip |
## Load and use the model
@@ -104,6 +105,7 @@ Use the following command to generate the datasets for training your model.
python3 generate_dataset.py <geonames_dataset> <wikipedia_dataset> <geonames_hierarchy_data>
+
| Parameter | Description |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| --cooc-sampling | Number of cooccurrence sampled for each place in the cooccurrence dataset |
@@ -111,6 +113,7 @@ Use the following command to generate the datasets for training your model.
| --adj-nside | Healpix resolution where places within are considered adjacent |
| --split-nside | Size of the zone where the train/test split are done |
| --split-method | [per_pair\|per_entity] Split each dataset based on places (place cannot exists in both train and test) or pairs(place can appears in train and test) |
+
### If you're in a hurry
French Geonames, French Wikipedia cooccurence data, and their train/test splits datasets can be found here : [https://projet.liris.cnrs.fr/hextgeo/files/](https://projet.liris.cnrs.fr/hextgeo/files/)
--
GitLab