UIMA FR

Filtrer les articles : Articles du jour - Articles de la semaine - Articles du mois - Tous les articles

Accès rapide aux derniers articles de la page

01/04/2010 : Parcours des annotations couvertes par une autre annotation 16/03/2010 : Tests unitaires pour UIMA avec UUTUC 06/03/2010 : Utilisation du CAS Editor 04/03/2010 : Release du collection reader pour Wikipedia v.0.4 21/02/2010 : UIMA & Wikipédia (5) : Gestion du projet avec Maven 14/02/2010 : UIMA & Wikipédia (4) : Analyse de la syntaxe MediaWiki 12/02/2010 : UIMA & Wikipédia (3) : Filtrage des données à charger 02/02/2010 : UIMA & Wikipédia (2) : Chargement d'un dump Wikipedia 01/02/2010 : UIMA & Wikipédia (1) : Proposition de Type System 29/01/2010 : Sortie d'Apache UIMA 2.3

Parcours des annotations couvertes par une autre annotation

3 votes

Par Fabien Poulard le 01/04/2010 à 00:00

Lorsque l’on travaille avec Apache UIMA et que l’on ajoute un nombre important d’annotations, il arrive un moment où l’on va vouloir filtrer certaines de ces annotations en fonction d’autres. Ainsi, assez couramment on éprouve le besoin de devoir récupérer des annotations qui couvrent la même zone de texte qu’une autre. Par exemple :

récupérer les mots contenus dans une phrases ;
récupérer les paragraphes dans un document ;
…

Il y a au moins deux approches dans Apache UIMA qui permettent de répondre à ce besoin : le subiterator et le FSMatchConstraint.

Utilisation du subiterator

L’approche basée sur le subiterator ne peut fonctionner que si les types que l’on cherche à accéder sont couverts par le type couvrant au sens de UIMA, c-à-d en terme de priorité des types (cf. [la javadoc de TypePriorities] ou cet email).

Considérons une annotation A qui couvre des annotations B de la manière suivante :

Il y a du texte et les annotations sont sur ce texte ...
[-----A:1-----]   [---A:2---]  [--------A:3--------]
 [B:1] [B:2]       [B:3]        [B:4]  [B:5] [B:6]

Dans l’exemple ci-dessus, nous sommes intéressés par les annotations B couvertes par l’annotation A:3, en d’autres termes les annotations B:4, B:5 et B:6.

La méthode est la suivante :

On récupère un pointeur sur l’annotation couvrante qui nous intéresse (A:3), à l’aide d’un itérateur par exemple ;
On récupére l’index des annotations couvertes (les B) ;
On appelle la méthode subiterator de l’index des annotations couvertes (B) en passant en paramètre l’annotation couvrante (A:3), la méthode nous retourne un itérateur sur les annotations B couvertes par A:3, soit B:4, B:5 et B:6.

Voici le code correspondant :

// Récupération des index
AnnotationIndex annAIdx = (AnnotationIndex) jcas.getAnnotationIndex(A.type);
AnnotationIndex annBIdx = (AnnotationIndex) jcas.getAnnotationIndex(B.type);
// On recherche ''A:3''
FSIterator annAIt = annAIdx.iterator();
while (annAIt.hasNext()) {
  A monA3 = (A) annAIt.next();
  // On récupére l'itérateur sur les annotations B couvertes par A3
  FSIterator annBSousA3It = annBIdx.subiterator(monA3);
  while (annBSousA3It.hasNext()) {
    // On récupére successivement B4, B5 et B6
    B annB = (B) annBSousA3It.next();
    System.out.println("Sous A3 : "+annB);
  }
}

Utilisation des contraintes (FSMatchConstraint)

Lorsque l’on ne connaît pas les priorités des types ou bien qu’elles ne correspondent pas à ce que l’on souhaite faire, il est nécessaire de passer par un mécanisme plus complexe (mais beaucoup plus puissant) : le système de contraintes d’index.

Dans le cas présent, nous allons définir une contrainte imposant que les attributs begin et end d’une annotation d’un type donné correspondent à une certaine valeur : celle de l’annotation couvrante. Puis nous pourrons générer un itérateur qui retournera les annotations de l’index qui respectent cette contrainte.

Voici l’implémentation d’une méthode qui fait cela :

/**
 * 
 * This method provides an iterator over typed annotations that either 
 * have an offset embedded in that of a given annotation in a document, 
 * or have the same offset as these annotation. 
 * 
 * @param theDocument  the document in which stand the source and
 *                                         target annotations
 * @param theAnnotation  the source annotation under which target 
 *                                         annotations that have to be drawn out
 * @param theType            the type of the target annotations that have 
 *                                         to be drawn out from the document under 
 *                                         the source annotation
 * @param isStrict              the boolean that defines the offset matching,
 *                                         offsets strictly equal if isStrict is true, begin 
 *                                         offsets greater or equal and end offsets less 
 *                                         or equal otherwise.  	
 * @return                           the iterator over the type theType annotations 
 *                                          which stand under the annotation theAnnotation 
 *                                          in the document theDocument 
 * 
 * @author Fabien Poulard
 * @author Jérôme Rocheteau
 * 
 * @license Apache 2.0
 */
public FSIterator subiterator(JCas theDocument, Annotation theAnnotation,Type theType,boolean isStrict) {
	// Ajout: déclaration de la variable type
	Type theAnnotationType = theAnnotation.getType();
	// On utilise le constraint factory
	ConstraintFactory theConstraints = theDocument.getConstraintFactory();
	// On définit les contraintes sur le début de l'annotation
	FSIntConstraint beginConstraint = theConstraints.createIntConstraint();
	if (isStrict) { 
		beginConstraint.eq(theAnnotation.getBegin());
	} else {
		beginConstraint.geq(theAnnotation.getBegin()); 
	}
	Feature beginFeature = theAnnotationType.getFeatureByBaseName("begin");
	FeaturePath beginPath = theDocument.createFeaturePath();
	beginPath.addFeature(beginFeature);
	FSMatchConstraint begin = theConstraints.embedConstraint(beginPath,beginConstraint);
	// ... puis sur la fin de l'annotation
	FSIntConstraint endConstraint = theConstraints.createIntConstraint();
	if (isStrict) {
		endConstraint.eq(theAnnotation.getEnd());
	} else {
		endConstraint.leq(theAnnotation.getEnd());
	}
	Feature endFeature = theAnnotationType.getFeatureByBaseName("end");
	FeaturePath endPath = theDocument.createFeaturePath();
	endPath.addFeature(endFeature);
	FSMatchConstraint end = theConstraints.embedConstraint(endPath, endConstraint);
	// JR: on définit une contrainte sur le type d'annotation
	FSTypeConstraint typeConstraint = theConstraints.createTypeConstraint();
	typeConstraint.add(theType); // 
	FeaturePath typePath = theDocument.createFeaturePath();
	FSMatchConstraint type = theConstraints.embedConstraint(typePath, typeConstraint);
	// On combine les contraintes
	FSMatchConstraint beginAndEnd = theConstraints.and(type,theConstraints.and(begin, end));
	// On génère un itérateur respectant ces contraintes
	FSIterator filteredIterator =
	theDocument.createFilteredIterator(theDocument.getAnnotationIndex().iterator(), beginAndEnd);
	return filteredIterator;
}

Cette méthode prend en paramètre le JCas dans lequel travailler, l’annotation couvrante (l’annotation A3 dans l’exemple précédent), le type d’annotation qui nous intéresse (le type B pour reprendre l’exemple précédent) et un booléen qui permet de préciser si l’on souhaite une correspondance exacte ou approximative des frontières.

Retour au sommaire

Tests unitaires pour UIMA avec UUTUC

1 vote

Par Fabien Poulard le 16/03/2010 à 00:00

La qualité du code développé dans le cadre des activités de recherche scientifique n’est pas toujours aussi bon qu’on pourrait l’espérer. Outre la nécessité (évidente à mes yeux) d’ouvrir le codes des activités scientifiques financées par l’État et les collectivités territoriales, il est également nécessaire de suivre de bonnes pratiques de programmation. L’écriture de tests unitaires et leur exécution régulière est une de ces bonnes pratiques.

Je présente dans ce billet un cas d’utilisation de la bibliothèque UUTUC, présentée lors du Workshop sur l’Ingénierie Logiciel, les Tests et l’Assurance Qualité pour le Traitement des Langues Naturelles (SETQA-NLP 2009), pour tester l’implémentation d’une bibliothèque développée et utilisée dans le cadre de ma thèse (tddts-uima-shingling).

Principe de UUTUC

UUTUC est une bibliothèque offrant un certain nombre de méthodes facilitant le processus de test des composants UIMA. On y trouve notamment un certain nombre de classes de type Factory qui facilitent la mise en place de chaînes de traitement simples pour expérimenter les composants.

À l’aide de ces classes, l’exécution d’un AE sur un simple fichier texte se résume à ces quelques lignes :

AnalysisEngine engine = 
  AnalysisEngineFactory.createAnalysisEngineFromPath("descriptors/tutorial/ex1/RoomNumberAnnotator.xml");
JCas jCas = 
  AnalysisEngineFactory.process(engine, "data/WatsonConferenceRooms.txt");

Le couplage de UUTUC avec JUnit permet de mettre en place un banc de tests unitaires :

Afin de tester la conformité de l’implémentation avec les spécifications attendues ;
Prévenir les problèmes de régression lors de l’évolution des composants

Écriture de tests unitaires

J’utilise le framework JUnit 4 pour les tests unitaires. Il suffit de faire précéder les méthodes considérées comme des tests par @Test pour qu’elles soient reconnues comme telles par JUnit. Exemple :

import org.junit.Test;
import static org.junit.Assert.*;
...
/**
 * This class defines the tests for the main methods of the Shingle class.
 */
public class ShingleTest {
  ...
  /**
   * This method just checks that the isComplete method works
   * @throws InvalidShingleException 
   * @throws OverloadShingleException 
   */
  @Test
  public void completeness() throws InvalidShingleException, OverloadShingleException {
	Shingle s1 = new Shingle(2);
	assertFalse( s1.isComplete() ); // before any adding
	s1.add( theShingleItems[0] );
	assertFalse( s1.isComplete() ); // after a first adding
	s1.add( theShingleItems[0] );
	assertTrue( s1.isComplete() ); // should be complete by now
  }
  ...
}

Combiné à UUTUC, il permet de mettre en place un environnement UIMA assez simplement. Ainsi dans l’exemple ci-dessous, nous définissons une méthode à exécuter avant chaque test (@Before) qui crée un JCas et y ajoute quelques annotations à l’aide des Factory de UUTUC :

/** Static data for testing */
private static String CAS_CONTENT = 
   "Suisse : inauguration d'une nouvelle synagogue, une première depuis 50 ans";
private static Integer[][] CAS_OFFSETS = { {0,6}, {9,21}, {22,24}, {24,27}, 
   {28,36}, {37,46}, {48,51}, {52,60}, {61,67}, {68,74} };
...
/**
 * This method is used to set up the testing environment, creating the
 * data necessary for the different tests methods.
 */
@Before 
public void setUp() throws UIMAException, IOException, ShinglingTestingException {
	// Set up a CAS with a couple of shingle items in
	TypeSystemDescription tsd = TypeSystemDescriptionFactory
			.createTypeSystemDescription("shingling-ts");
	theTestingCas = JCasFactory.createJCas(tsd);
	theTestingCas.setDocumentText(CAS_CONTENT);
	for(Integer[] idx: CAS_OFFSETS) {
		AnnotationFactory.createAnnotation(theTestingCas, 
						idx[0], idx[1], ShingleItem.class) );
	}
}

Malheureusement il y a assez peu de documentation concernant UUTUC. Il est ainsi régulièrement nécessaire d’aller jeter un œil au code source qui heureusement est très bien écrit.

Intégration avec Maven

Maven modélisant toutes les étapes du cycle de développement, il intègre une étape test entre le compile et le package. La gestion des tests unitaires se faisant quant à eux au travers du plugin maven-surefire-plugin.

Il faut tout d’abord rajouter dans le pom.xml les informations de dépendance sur UUTUC et JUnit :

<repository>
  <snapshots>
    <enabled>false</enabled>
  </snapshots>
  <id>uutuc-googlecode</id>
  <name>uutuc Google Code repository</name>
  <url>http://uutuc.googlecode.com/svn/repo/</url>
</repository>
...
<!-- UUTUC for testing -->
<dependency>
  <groupId>org.uutuc</groupId>
  <artifactId>uutuc</artifactId>
  <version>0.9.10</version>
  <optional>false</optional>
  <scope>test</scope>
</dependency>
<!-- JUnit 4 for testing -->
<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>4.3.1</version>
  <scope>test</scope>
</dependency>

Il suffit ensuite de faire appel au plugin maven-surefire-plugin qui prend en charge tout ce qui concerne les tests, sous réserve que ces derniers soient bien présents dans src/test/java :

<!-- Testing -->
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <configuration>
    <reportFormat>brief</reportFormat>
    <useFile>false</useFile>
  </configuration>
</plugin>

Il est alors possible de lancer l’exécution des tests avec Maven :

$ mvn test
...
-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running tddts.uima.shingling.ShingleTest
Tests run: 16, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 3.992 sec

Results :

Tests run: 16, Failures: 0, Errors: 0, Skipped: 0
...

Plus d’excuse pour ne pas tester votre code maintenant ! L’excuse de faire du prototypage pour la recherche n’en est pas une bonne dès que les résultats que vous publiez dépendent de la qualité dudit code. C’est votre intégrité et honnêteté scientifique qui est en jeux ;)

Retour au sommaire

Utilisation du CAS Editor

1 vote

Par Fabien Poulard le 06/03/2010 à 00:00

Il y a quelques temps j’avais écrit une documentation en interne dans mon laboratoire sur l’utilisation du ’’CAS Editor’’. À l’époque c’était assez éprouvant car ce dernier se présentait sous la forme d’une application RCP Eclipse.

Depuis la version 2.3.0, le CAS Editor a été intégré sous la forme d’un plugin Eclipse. L’occasion de remettre la doc au goût du jour et de la partager avec le reste du monde.

Avant propos

Avant toute chose il est nécessaire d’installer les plugins Eclipse de UIMA. Pour ce faire, il faut ajouter le dépôt Eclipse : http://www.apache.org/dist/incubator/uima/eclipse-update-site/ dans l’outil de gestion des plugins. Ensuite il suffit de rechercher UIMA et d’installer tous les plugins associés.

À noter que les personnes ayant installé les plugins des versions antérieures doivent simplement faire une mise-à-jour afin de faire apparaître le plugin CAS Editor qui n’était pas présent auparavant.

Un petit redémarrage d’Eclipse et vous devriez être paré pour la suite...

Initialiser un projet

Le fonctionnement du CAS Editor est lié à :

une vue CAS Editor
un projet CAS Editor

Ceci est spécifique à la version 2.3 d’UIMA et devrait évoluer dans les prochaines versions.

La vidéo ci-dessous illustre les étapes nécessaires à l’initialisation d’un projet et l’importation d’un corpus :

Créer un projet CAS Editor
Passe en vue CAS Editor afin d’accéder aux fonctionnalités spécifiques
Créer un répertoire corpus
Importer dans ce répertoire corpus des fichiers textes afin de les transformer en CAS
Ouvrir et visualiser le contenu des fichiers (CAS) du corpus

Ajouter des annotations manuellement

Il n’est possible d’ajouter des annotations que si le type d’annotation à ajouter est présent dans le Type System. Si toutefois vous ajoutez des types d’annotation à un Type System qui est déjà utilisé par le projet CAS Editor, les nouveaux types ne vont pas apparaître. Il est nécessaire de fermer puis réouvrir le projet.

Il y a deux façons d’ajouter une annotation dans un CAS, l’une permet d’ajouter la même annotation par un simple appuie sur Entrée :

Sélectionner le texte
Sélectionner le type d’annotation dans le Feature View
Appuyer sur Entrée

l’autre permet de choisir le type de chaque nouvelle annotation rajoutée :

Sélectionner le texte
Appuyer sur shift + entrée
Choisir l’annotation à ajouter

La vidéo ci-dessous illustre ces deux méthodes :

Utiliser un AE pour ajouter des annotations

Il est tout à fait possible d’utiliser directement un Analysis Engine directement dans le CAS Editor afin d’ajouter des annotations aux CAS. La procédure est toutefois un peu contraignante et surtout peu intuitive. Je vais décrire l’approche qui consiste à utiliser un composant empaqueté dans un PEAR.

Construction et installation du PEAR

Pour l’exemple je vais prendre le WhitespaceTokenizer, ce dernier a deux avantages pour ce tutoriel :

Il est simple d’utilisation (pas de paramètres) et n’a pas de dépendances sur d’autres composants
Il fait parti officiellement d’UIMA et distribué sur le site : UIMA Annotator Addons & Simple Server & Pear packaging tools

Il nous faut la version source du paquet UIMA Annotator Addons & Simple Server & Pear packaging tools. Une fois téléchargée, décompressez là quelque part et placez-vous dans le répertoire uimaj-annotator-addons-2.3.0-incubating/WhitespaceTokenizer/.

Il nous faut modifier un peu le pom.xml afin d’y ajouter les dépôts qui sont normalement déclarés dans le pom parent :

...
  <repositories>
    <repository>
      <id>apache</id>
      <name>Apache UIMA</name>
      <layout>default</layout>
      <url>http://people.apache.org/repo/m2-incubating-repository/</url>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>apache</id>
      <name>Apache UIMA</name>
      <url>http://people.apache.org/repo/m2-incubating-repository/</url>
      <layout>default</layout>
    </pluginRepository>
  </pluginRepositories>
  ...

Il est alors possible de créer le PEAR avec maven en lançant dans le répertoire du WhitespaceTokenizer :

$ mvn package

Le pear est alors créé dans le répertoire target/ sous le nom WhitespaceTokenizer.pear. Il faut l’installer à l’aide du PearInstaller.

Une fois le PEAR installé, il faut créer un répertoire processing dans le projet du CAS Editor, y importer le descripteur PEAR, l’intégrer à un composant Agregate. On peut alors le faire tourner sur une partie du corpus.

La vidéo ci-dessous présente ces dernières phases :

Visualiser et modifier les annotations

Le but du CAS Editor est tout de même de pouvoir visualiser et manipuler les annotations, ce qui se fait dans l’éditeur.

La visualisation des annotations est configurable par le menu contextuel Show annotations où l’on sélectionne les annotations à afficher. Le mode de mise en valeur de ces dernières se configure dans les propriétés du projet.

Le parcours des annotations s’opère de plusieurs manières :

Par le menu contextuel, Mode permet de sélectionner la façon dont on parcours/sélectionne les annotations ;
L’onglet Feature Structure View permet de sélectionner les types d’annotation à faire apparaître dans l’onglet Outline, il alors possible dans ce dernier de supprimer des annotations (croix rouge) ;
Les onglets Edit View permettent quant à eux de modifier les valeurs des champs de l’annotation sélectionnée.

La vidéo ci-dessous illustre ces différentes manipulations :

Retour au sommaire

Release du collection reader pour Wikipedia v.0.4

1 vote

Par Fabien Poulard le 04/03/2010 à 00:00

Wikipedia est une incroyable source d’information, de données et plus généralement d’actes langagiers (utilisation du langage). C’est une ressource sans équivalent pour les chercheurs en traitement automatique des langues (TAL).

Le MediaWiki UIMA Loader est un composant UIMA, de type collection reader, permettant de tirer parti de Wikipédia pour la construction de corpus. La version 0.4 est la première release officiellement annoncée du composant.

Pour les impatients :

Le jar du composant (et ses dépendances : mwdumper et wikimodel.wem)
Les sources du composant

Présentation du composant

Le composant MediaWiki UIMA Loader est un collection reader permettant de charger des données issues d’un MediaWiki, notamment Wikipédia et ses projets dérivés ...

Le composant est distribué sous licence Apache 2. Vous pouvez donc l’utiliser dans le cadre d’un travail académique ou commercial. Dans les deux cas, si vous trouvez le composant utile, n’hésitez pas à me dire ce que vous en pensez, si vous souhaitez de nouvelles fonctionnalités ou si vous rencontrez des bugs.

Contrairement à plusieurs projets existant, le composant n’attaque pas directement les sites Wikipedia. Il ne nécessite pas non plus de créer un miroir local de la base de données MediaWiki. Il travaille directement à partir des dumps XML, ce qui présente les avantages suivant :

Pas d’accès répétitifs aux serveurs des projets MediaWiki, préservant la bande passante et le temps de calcul de ces derniers ;
Pas besoin de déployer un serveur de base de données en local et d’y importer les données de dump (si ça vous amuse, vous pouvez toujours suivre ce tutoriel) ;
Limiter l’espace disque disponible pour stocker les informations en utilisant directement la version compressée des dumps ;
Limiter la latence dans l’accès aux données provoquées par les requêtes réseau ou bien le serveur SQL.

Les fonctionnalités de cette version 0.4 sont les suivantes :

Chargement à partir d’un dump XML compressé ou non ;
Nombreuses options de filtrage (voir plus bas) concernant les pages et révisions à charger dans la chaîne de traitement ;
Interprétation de la syntaxe wiki et annotation des Titres, Sections, Paragraphes et Liens (cf. ce billet pour plus d’informations).

Installation

Avant d’installer et d’utiliser le composant, il est nécessaire d’avoir un environnement UIMA installé. Si ce n’est pas le cas, se référer à ce tutoriel.

Le plus simple est de récupérer le jar du composant dans l’espace de téléchargement de uima-fr, ainsi que les dépendances : mwdumper et wikimodel.wem.

Si vous souhaitez reconstruire le jar vous mêmes, il vous faut télécharger les sources du composant, toujours dans l’espace de téléchargement de uima-fr,et les compiler à l’aide de maven :

$ tar -xzvf mediawiki-uima-loader-0.4.1.tar.gz
...
$ cd mediawiki-uima-loader-0.4.1
$ mvn package
...

Le jar devrait être créé dans le répertoire target/, les dépendances quant à elles auront été téléchargées dans votre dépôt maven local.

Utilisation

Vous pouvez utiliser le composant dans n’importe quelle chaîne de traitement UIMA, de la même façon que vous utilisez un composant classique de type collection reader. La démarche ci-dessous concerne l’utilisation de l’outil cpeGui, mais elle devrait être similaire pour les autres outils du même type.

Le cpeGui n’est pas capable en l’état de charger un descripteur xml depuis un jar. Avant tout, il est donc nécessaire d’extraire le descripteur du composant du jar afin de le rendre accessible. Si vous avez compilé le composant vous même, le descripteur est présent dans le répertoire desc. Sinon, il suffit de l’extraire du jar :

$ jar -x wikipedia-cr.xml -f mediawiki-uima-loader-0.4.1.jar

Il est nécessaire de rajouter le jar du composant et de ses dépendances dans le UIMA_CLASSPATH, avant de lancer le cpeGui en ligne de commande. Pour l’exemple, nous considérerons que le jar du composant est dans le répertoire courant et que les dépendances sont dans le dépôt maven local :

$ export UIMA_CLASSPATH=$UIMA_CLASSPATH:~/.m2/repository/org/wikimedia/mwdumper/1.16/mwdumper-1.16.jar:~/.m2/repository/org/wikimodel/org.wikimodel.wem/2.0.7-SNAPSHOT/org.wikimodel.wem-2.0.7-SNAPSHOT.jar:mediawiki-uima-loader-0.4.1.jar
$ cpeGui

Dans la partie de l’interface dédiée au Collection Reader, cliquez sur Browse et allez sélectionner le descripteur du composant que nous avons extrait du jar (wikipedia-cr.xml). L’interface se modifie afin d’offrir les champs de paramétrage du composant.

Le seul paramètre obligatoire est le champs Input Xml Dump. Vous devez renseigner dans ce dernier le chemin menant au dump XML de Wikipedia (ou tout autre dump MediaWiki) que vous souhaitez charger. Par exemple : ~/frwiki-20100111-pages-meta-history.xml.bz2. Le composant est capable de lire un dump, qu’il soit compressé ou non.

Les autres paramètres concernent le filtrage à mettre en place lors du chargement des données :

Latest Revision Only, si vous cochez cette case seules la dernière révision disponible pour chaque article sera chargée, sinon toutes les révisions (présentes dans le dump) seront chargées ;
Ignore Talks, si vous cochez cette case, les pages de type discussion seront ignorées, sinon elles seront également chargées ;
Config Namespaces Filter, ce champs permet de spécifier les espaces de nom à considérer lors du chargement. S’il est laissé vide, tous les espaces de nom sont chargés. Pour wikipedia les espaces de nom disponibles sont :
- -2 : ressources de type média ;
- -1 : pages spéciales ;
- 0 : espace de nom principal où l’on trouve les articles de l’encyclopédie ;
- 1 : discussions à propos des articles ;
- 2 : pages des utilisateurs ;
- 3 : discussion à propos des utilisateurs ;
- 4 : espace Wikipédia (le projet)
- 5 : espace de discussion autour du projet Wikipédia
- 6 : fichiers
- 7 : discussion à propos des fichiers
- 8 : espace MédiaWiki (le logiciel)
- 9 : discussion à propos de MédiaWiki
- 10 : modèles
- 11 : discussion à propos des modèles
- 12 : aide
- 13 : discussion à propos de l’aide
- 14 : catégories
- 15 : discussion à propos des catégories
- 100 : portail
- 101 : discussion à propos du portail
- 102 : projets
- 103 : discussion autour des projets
- 104 : références
- 105 : discussion autour des références

Par exemple pour prendre en considération uniquement toutes les pages de discussion : 1,3,5,7,9,11,13,15,101,103,105, ou bien pour prendre en compte tous les espaces de nom excepté celui des catégories : !14 ;

Config Title Match, ce champs permet à l’aide d’une expression rationnelle de filtrer les pages dont le titre valide l’expression rationnelle. Par exemple : A.* pour toutes les pages commençant dont le titre commence par A ;
Config List Filter et Config Exact List Filter, ces champs permette d’indiquer en paramètre le chemin d’un fichier contenant un nom de page par ligne. Seules les pages précisées dans ce fichier seront chargées. Si c’est le paramétrage Exact qui est employé, le titre doit correspondre exactement, autrement le filtre vérifie s’il correspond au titre de l’article ou éventuellement de sa page de discussion ;
Config Revision List Filter, ce champs permet de renseigner le chemin d’un fichier contenant en paramètre les numéros de révision à charger (une révision par ligne) ;
Config Before Timestamp Filter et Config After Timestamp Filter, ces champs permettent de délimiter temporellement les données à importer en indiquant des dates limites de début et de fin au format yyyy-MM-dd’T’HH:mm:ss’Z’.

Une fois le composant paramétré, il suffit de renseigner les autres composants de la chaîne comme vous le faites habituellement et de lancer l’exécution.

Attention, si vous exportez le contenu traité par le composant, à l’aide du composant XmiWriter par exemple, à partir d’un dump compressé, prenez en compte que le volume de données risque d’être 20 à 100 fois supérieures à la taille originale du dump. Ainsi, il faut compter une vingtaine de Go minimum pour la version française de Wikipédia en ne considérant que les dernières révisions des articles.

Retour au sommaire

UIMA & Wikipédia (5) : Gestion du projet avec Maven

2 votes

Par Fabien Poulard le 21/02/2010 à 00:00

La création de composants UIMA permettant d’accéder et tirer parti de Wikipédia offrirait de nouvelles perspectives au traitement des langues en offrant un accès aisé à cette formidable ressource que représente l’encyclopédie libre. Je compte m’atteler à la création de tels composants et vais tâcher de publier plusieurs billets décrivant ma démarche en cours.

Voici le cinquième billet, plus orienté technique de développement, qui discute de la gestion du projet avec Maven, permettant notamment de gérer automatiquement les dépendances à MWDumper et à Wikimodel.

Qu’est-ce que Maven ?

Maven est une sorte de super-gestionnaire de projet qui peut se charger d’à peu près tout : dépendances, compilation, packaging, lancement des tests unitaires, ... L’outil est disponible sur la plupart des distribution, pour ma part sous Ubuntu :

$ sudo aptitude install maven2

L’objectif de ce billet est d’expliquer comment, à l’aide de notre génial ingénieur de recherche, j’ai pu utilisé maven pour gérer la construction du collection reader pour Wikipedia.

Récupérer les dépendances

La première complication lorsque l’on souhaite compiler le collection reader ce sont les dépendances, il y en a trois :

UIMA, mais ceux qui veulent utiliser le composant doivent d’ores et déjà avoir réglé ce problème ;
le projet mwdumper de MediaWiki ;
le sous-projet org.wikimodel.wem de WikiModel.

Par chance tous ces projets sont déjà gérés par maven ce qui va fortement nous faciliter la tâche. Les étapes à suivre sont les suivantes :

Obtenir une version des sources de chacun des projets
Les compiler avec maven
Les installer dans le dépôt local de maven

Ainsi pour mwdumper :

$ svn co http://svn.wikimedia.org/svnroot/mediawiki/trunk/mwdumper
...
$ cd mwdumper
$ mvn compile
...
$ mvn install
...

Une fois ces étapes terminées, un nouveau dossier doit apparaître dans votre dépôt local : ~/.m2/repository/org/wikimedia/mwdumper/ ; il doit contenir un dossier correspondant à la version compilée (1.16 pour moi) et dans ce dossier les fichiers suivants :

mwdumper-1.16.jar
mwdumper-1.16.pom

Il faut procéder de la même manière pour WikiModel :

$ svn co http://wikimodel.googlecode.com/svn/trunk/org.wikimodel.wem
...
$ cd org.wikimodel.wem
$ mvn compile
...
$ mvn install
...

Vous devriez de la même manière voir apparaître dans votre dépôt local : ~/.m2/repository/org/wikimodel/org.wikimodel.wem/ ; il doit contenir une structure similaire.

Ces étapes sont nécessaires pour la suite car elles placent les dépendances dans le dépôt local de maven, là où il ira les chercher lors de la compilation.

Écriture du pom.xml

Revenons maintenant au composant UIMA. L’intelligence de Maven se configure dans un fichier à la racine du projet et nommé pom.xml.

Dans un premier temps, il faut définir le projet en lui donnant :

Un identifiant de groupe (dans le cas où le projet appartiendrait à un groupe de projets) : groupId
Un identifiant d’artefact, c-à-d de ce que le projet va produire : artifactId
Spécifier une version : version
Donner un nom et une description
Renseigner les informations concernant les licences
Spécifier le type de packaging que l’on souhaite obtenir

<project 
   xmlns="http://maven.apache.org/POM/4.0.0" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"
>
  <modelVersion>4.0.0</modelVersion>
  <groupId>uima.wikipedia</groupId>
  <artifactId>uima-mediawiki-loader</artifactId>
  <version>0.4</version>
  <packaging>jar</packaging>
  <name>MediaWiki UIMA Loader</name>
  <description>This is a UIMA Collection Reader for the MediaWiki dumps (Wikipedia &amp; co).</description>
  <licenses>
    <license>
      <name>Apache 2</name>
      <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
    </license>
  </licenses>
  ...
</project>

Dans un second temps, nous définissons les dépendances nécessaires à la construction de notre composant. Comme nous l’avons vu précédemment, il y en a plusieurs :

UIMA, et plus précisément uimaj-core et uimaj-document-annotation
WikiModel, et plus précisément org.wikimodel.wem
MWdumper

Les dépendances se déclarent entre les tags <dependencies>, en indiquant notamment la version nécessaire.

...
  <dependencies>
    <!-- Required to generate the Java classes -->
    <dependency>
      <groupId>org.apache.uima</groupId>
      <artifactId>uimaj-core</artifactId>
      <version>2.3.0-incubating</version>
      <scope>compile</scope>
    </dependency>
    <!-- DocumentAnnotation UIMA Type --> 
    <dependency>
      <groupId>org.apache.uima</groupId>
      <artifactId>uimaj-document-annotation</artifactId>
      <version>2.3.0-incubating</version>
      <scope>compile</scope>
    </dependency>
    <!-- WikiModel -->
    <dependency>
       <groupId>org.wikimodel</groupId>
       <artifactId>org.wikimodel.wem</artifactId>
       <version>2.0.7-SNAPSHOT</version>
    </dependency>
    <!-- WikiMedia Dumper -->
    <dependency>
        <groupId>org.wikimedia</groupId>
	<artifactId>mwdumper</artifactId>
	<version>1.16</version>
    </dependency>
  </dependencies>
  ...

Comme vous l’avez certainement remarqué, on a précisé que le projet dépendait d’UIMA, mais contrairement aux dépendances sur MWDumper et WikiModel, nous n’avons pas installé ces dernières dans le dépôt maven local. En fait Maven va être capable d’aller chercher tout seul ces dépendances grâce au dépôt maven mis en ligne par Apache UIMA. Il suffit de préciser l’existence de ce dépôt :

...
  <repositories>
    <!-- Apache UIMA repository -->
    <repository>
      <id>apache</id>
      <name>Apache</name>
      <url>http://people.apache.org/repo/m2-incubating-repository</url>
    </repository>
  </repositories>
  ...

Finalement, on précise le processus de construction du composant entre les tags <build>. Dans nos cas cela revient tout simplement à préciser où aller chercher les sources, où placer les fichiers compilés et préciser ce qui doit être considérés comme des ressources et donc placé dans le Jar en plus des classes.

On utilisera de plus le plugin maven-compiler-plugin afin de préciser la version de Java que l’on souhaite pour la compilation.

...
  <build>
    <plugins>
      <!-- Java Compiler -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>2.0.2</version>
        <configuration>
          <source>1.5</source>
          <target>1.5</target>
        </configuration>
      </plugin>
    </plugins>
    <sourceDirectory>src</sourceDirectory>
    <outputDirectory>bin</outputDirectory>
    <resources>
      <resource>
        <directory>desc</directory>
      </resource>
    </resources>
  </build>
  ...

Le pom.xml est suffisant à cette étape pour permettre de lancer la compilation du projet et le packaging.

$ mvn compile
...

Vous devriez constater que le dossier bin s’est peuplé des classes compilées.

$ mvn package
...

Vous devriez maintenant constater l’apparition d’un dossier target dans lequel vous trouverez notamment un Jar nommé : uima-mediawiki-loader-0.4.jar. Et voilà, dans l’état il est possible d’obtenir un Jar du projet à partir des sources sans trop de problèmes. Toutefois la première étape de récupération des dépendances me paraît trop contraignantes. Il est possible, à l’instar d’Apache UIMA, de mettre en place un dépôt contenant des versions compilées des dépendances afin que maven aille directement les chercher.

Mettre en place un dépôt pour les dépendances

Un dépôt maven ce n’est ni plus ni moins qu’un système de fichiers respectant une certaine structure et accessible par http (par exemple).

J’ai créé un dossier sur mon serveur que j’ai rendu accessible par http à l’aide d’Apache, puis j’y ai collé l’arborescence concernant mwdumper et wikimodel quiu était présente dans mon dépôt local :

~/.m2/repository//org/wikimedia/...
~/.m2/repository//org/wikimodel/...

Il y a une petite nuance tout de même, lorsque le dépôt est distant, les fichiers doivent être accompagnés de leurs checksums afin de vérifier que le téléchargement s’est bien déroulé. Le plus simple pour générer ces fichiers de checksums est de réitérer l’installation dans le dépôt maven local avec une option supplémentaire :

$ mvn install -DcreateChecksum=true
...

Vous trouverez alors dans le dépôt local les fichiers en *.md5 et *.sha1 qu’il faut également transférer sur le serveur.

Une fois que le dépôt distant est mis en place, il suffit de le déclarer dans le pom.xml :

...
   <repository>
      <id>uima-fr.org</id>
      <name>UIMA Fr</name>
      <url>http://www.uima-fr.org/m2-repo/</url>
   </repository>
   ...

Il est maintenant possible de compiler le composant sans avoir à récupérer les dépendances en amont. Tout se fait automatiquement et de manière transparente pour l’utilisateur... c’est assez plaisant.

Comme je suis un fainéant, je trouve que ce serait cool de pouvoir déployer automatiquement mon composant sur mon dépôt, c’est tellement pratique les dépôts !

Déployer le composant sur le dépôt

J’ai choisi de pouvoir déployer mon composant sur le dépôt par ssh, pour des questions de sécurité. Mais il est également possible de le faire par ftp. Le déploiement par ssh nécessite tout d’abord de pouvoir se connecter automatiquement au serveur par ssh à l’aide d’un échange de clé, puis il suffit de renseigner dans le pom.xml l’adresse du dépôt et dans ~/.m2/settings.xml de préciser les modalités de connexion au dépôt.

Connexion automatique par ssh

Je ne vais pas détailler ici comment déployer un serveur ssh et faire tourner un ssh-agent en local, il y a tout un tas de tutoriels disponibles sur internet pour ça. Ce qu’il faut juste retenir, c’est que maven ne se connectera au serveur ssh si les deux conditions suivantes sont remplies :

Le serveur est connu de ssh (il est enregistré dans .ssh/know_hosts) ;
La connexion peut se faire par échange de clés (pas de mot de passe).

Le plus simple pour s’assurer de tout cela est de se connecter directement manuellement au serveur :

Si le serveur est inconnu, ssh demandera s’il doit être ajouté à la liste des hôtes connus : acceptez ;
Si le serveur vous demande un mot de passe c’est qu’il ne connaît pas votre clé, il suffit de lui donner.

Copiez donc le contenu de votre clé publique que vous trouverez dans le fichier ~/.ssh/id_dsa.pub ou bien ~/.ssh/id_rsa.pub. Elle doit ressembler à quelque chose comme ceci :

ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAzqedhFIi8hy743U7pEvLMQvCEeAo/CxmLjF4jF2WguguN+U/4GsJrONvgoWMYXRn0zVMoHNpCEXQ+BT80ZTnv+MILu5elgFsE18bFA+7qjd454LwuZpoIoJOsCNyJKyGjy7ER5cZGN/z8G6cmSJTGauc270W7WJQELqKM3rfqPJH4FXPF9+WDP4UK/o7k54g36/3hHeBmqW++mpyEwkm0eT+GlBRlmP4NjVJACMoyYwl2S1Ep/m85aYR+95m3neHFZpUPmEyN52/Sod7ak28AHZ0M5oE/nRoUr1AAc0LzJw7BM327fAO6o7iHcfoIdo7pix2KLoteqT8tQIRQUmzxQ== grdscarabe@grdscarabe-desktop

Attention, cette clé se trouve sur le poste client à partir duquel maven se connaîtra !

Copiez donc cette clé dans le fichier ~/.ssh/authorized_keys, si ce fichier n’existe pas créez-le. Faites bien attention à ce qu’il soit dans le répertoire personnel de l’utilisateur que maven utilisera pour se connecter (le votre très certainement).

Une fois cette opération effectuée, vous devriez pouvoir vous connecter au serveur sans que ce dernier ne vous demande de mot de passe. Il se peut que si vous ayez protégé votre clé privée par un mot de passe, le ssh-agent vous le demande. Dans ce cas vous êtes de mon point de vue suffisamment au courant du problème pour ne pas lire cette section. Sinon vous êtes bien malin d’avoir mis un mot de passe :)

Déclaration du dépôt dans le pom.xml

Il suffit de déclarer dans le dépôt dans le pom.xml, nous l’appellerons ici uimafr-repository. Il est également nécessaire de charger l’extension wagon-ssh-external qui permet à maven de déployer par ssh :

...
   <extensions>
      <!-- Enabling the use of SSH -->
      <extension>
        <groupId>org.apache.maven.wagon</groupId>
         <artifactId>wagon-ssh-external</artifactId>
         <version>1.0-beta-6</version>
      </extension>
   </extensions>
   <distributionManagement>
      <repository>
         <id>uimafr-repository</id>
         <url>scpexe://www.uima-fr.org//home/www-data/org_uima-fr_www/m2-repo</url>
      </repository>
   </distributionManagement>
   ...

Modalités de connexion au dépôt

Enfin, il faut localement configurer maven pour reconnaître le dépôt uimafr-repository. Cette configuration se fait par le fichier ~/.m2/settings.xml. S’il n’existe pas, créez-le puis copiez-collez y le contenu suivant :

<settings>
  <servers>
    <server>
      <id>uimafr-repository</id>
      <configuration>
        <sshExecutable>ssh</sshExecutable>
        <scpExecutable>scp</scpExecutable>
      </configuration>
    </server>
  </servers>
</settings>

En gros ce dernier permet de préciser quels sont les outils à utiliser pour la connexion ssh. Sous linux, nous utiliserons les outils ssh pour la connexion et scp pour le transfert de fichier.

Déploiement

Et voilà, maintenant pour déployer mon composant sur le dépôt, il me suffit de faire :

$ mvn deploy
...

Elle est pas belle la vie ?

Extensions possibles

Il y a bien des extensions possibles pour rendre maven encore plus pratique pour la gestion de ce projet. J’en vois notamment deux :

La génération automatique des classes de types UIMA à partir de JCasGen ;
L’empaquetage dans le même Jar du projet et des dépendances sur MWDumper et WikiModel.

Dans le premier cas, la solution au problème doit certainement se trouver du côté du ’’exec-maven-plugin’’. Dans le second cas, il faudrait aller voir du côté de ’’maven-assembly-plugin’’.

Nouvelle version du composant

Et je conclus ce looong billet en distribuant la nouvelle version, estampillée 0.4, du collection reader pour Wikipedia : par ici ! Vous trouverez les dépendances nécessaires à son fonctionnement dans le dépôt maven de uima-fr.

Vous pouvez tester le composant à l’aide du cpeGui :

$ UIMA_CLASSPATH=~/.m2/repository/uima/wikipedia/mwuima-loader/0.4/mwuima-loader-0.4.jar:~/.m2/repository/org/wikimedia/mwdumper/1.16/mwdumper-1.16.jar:~/.m2/repository/org/wikimodel/org.wikimodel.wem/2.0.7-SNAPSHOT/org.wikimodel.wem-2.0.7-SNAPSHOT.jar cpeGui

Bien sûr, si vous n’avez pas installé le composant avec maven, il faudra modifier en conséquence les chemins du UIMA_CLASSPATH.

Autres articles

Retour au sommaire

UIMA & Wikipédia (4) : Analyse de la syntaxe MediaWiki

0 vote

Par Fabien Poulard le 14/02/2010 à 00:00

Wikipedia est une incroyable source d’information, de données et plus généralement d’actes langagiers (utilisation du langage). Ce dernier point est très important pour nous autres chercheurs en traitement automatique des langues. En effet, nous avons besoin d’observer de très nombreux exemples d’utilisation du langage, que ce soit de manière automatique ou manuelle. Pour ce faire, nous compilons de vastes exemples d’utilisation du langage sous forme de corpus.

Voici le quatrième billet qui discute de l’analyse syntaxique du contenu des pages wiki pour la suppression des balises Wiki.

Analyse syntaxique des pages MediaWiki

Il existe plusieurs initiatives de programmes permettant d’interpréter la syntaxe de MediaWiki. Il y a le code PHP utilisé par MediaWiki et qui sert de référence, mais également plusieurs autres initiatives notamment en Java.

La plupart des initiatives Java ont pour objectif de produire des version XHTML ou PDF des pages en syntaxe wiki et ne donnent pas accès à l’arbre syntaxique de la page. Un programme en C basé sur Flex/Bison et développé dans le cadre du projet MediaWiki offre cette possibilité.

Parmi les initiatives en Java qui semblent intéressantes pour le collection reader UIMA :

JAMWiki qui est plus ou moins une réécriture de MediaWiki en Java et dont l’analyseur syntaxique semble réutilisable ;
WikiModel supporte plusieurs langages Wiki ;
Bliki

J’ai tout d’abord essayé Bliki pour traiter la syntaxe de MediaWiki. Ce dernier s’est toutefois avéré assez complexe, notamment au niveau de son architecture, de telle façon que je n’ai pas réussi à obtenir ce que je voulais. Je me suis alors tourné vers WikiModel qui offre un analyseur syntaxique (Wiki Event Model (WEM)) au fonctionnement proche de SAX.

WikiModel pour MediaWiki

Le gros avantage de WikModel est qu’il offre directement un parseur pour MediaWiki : org.wikimodel.wem.mediawiki.MediaWikiParser. Le parseur analyse du code Wiki brute et, comme un parseur SAX classique, lance des évènements à une instance implémentant l’interface org.wikimodel.wem.IWemListener. J’ai choisi de créer une classe MediawikiCasConverter implémentant cette interface et gérant elle même le lancement du parseur sur les textes brutes extraits des révisions.

import org.wikimodel.wem.mediawiki.MediaWikiParser
import org.wikimodel.wem.IWemListener;
...
public class MediawikiCasConverter implements IWemListener {
 
  public MediawikiCasConverter() {
    theParser = new MediaWikiParser();
  }
 
  public void runParser(String rawWikiText) throws WikiParserException {
    // We use a string reader to parse the raw wiki texte
    StringReader reader = new StringReader(rawWikiText);
    // Parsing
    theParser.parse(reader, this);
  }
 
  // IWemListener methods below
  ...
}

Les méthodes du IWemListener sont de deux types. Les premières sont des méthodes one shot, ie elles sont appelées une seule fois lorsqu’un élément est rencontré. Ce sont notamment celles qui concernent le texte et leur mise en forme :

onEscape(String str)
onSpace(String str)
onSpecialSymbol(String str)
onWord(String str)
onReference(String str)

Les secondes sont des méthodes à la SAX en deux temps : begin et end. Ce sont notamment celles qui concernent la structuration du texte :

beginHeader(int headerLevel, WikiParameters params)
endHeader(int headerLevel, WikiParameters params)
beginSection(int docLevel, int headerLevel, WikiParameters params)
endSection(int docLevel, int headerLevel, WikiParameters params)
beginParagraph(WikiParameters params)
endParagraph(WikiParameters params)
beginList(WikiParameters params, boolean ordered)
endList(WikiParameters params, boolean ordered)

La plupart de ces méthodes ne font que des appels à une fonction de plus haut niveau qui collecte les données textuelles de la page et qui maintient l’index du CAS : addToContent. C’est notamment le cas pour la méthode onWord qui est appelée lorsque le parseur rencontre un nouveau mot :

/**
 * This method adds the string in parameter into the collected content
 * and then increment the offset by the size of this string.
 * 
 * @param str the string to be added to the content
 */
protected void addToContent(String str) {
  if ( str != null ) {
    theTextContent.append(str);
    theOffset += str.length();
  }
}
...
/** Called when a word is encountered */
public void onWord(String str) {
  addToContent(str);
}

J’ai choisi de transposer une partie des informations contenues dans les pages de Wikipedia sous la forme d’annotations. J’ai ainsi ajouté les types :

Header pour les titres qui possède un attribut Level indiquant le niveau de titre ;
Paragraph pour différencier les paragraphes ;
Section pour repérer les sections même si je ne suis pas certain d’avoir bien compris le principe de section dans MediaWiki. Ce type possède les attributs Level pour le niveau de section (cf. niveau de titre), Parent pointant sur la section parente et Title pointant sur le Header correspondant à ladite section ;
Link pour les liens divers et variés qui possède des attributs Label et Link pour respectivement l’étiquette du lien et son adresse.

En ce qui concerne les liens, j’ai choisi pour le moment d’ignorer les images qui me semblent apporter plus de bruit qu’autre chose.

La mise en place de ces annotations se fait assez facilement :

Lors d’un appel à begin..., l’annotation est créée est stockée dans une liste, la plupart des informations excepté son index de fin est renseigné à ce moment ;
Lors de l’appel correspondant à end..., la dernière annotation de la liste est récupérée et on fixe son index de fin (setEnd) ;
Lorsque l’analyse est terminée, toutes les annotations sont accessibles par la méthode getAnnotations afin de les ajouter à l’index du CAS.

Cette approche permet de dédier toute la partie analyse à une classe. Si jamais l’on veut ignorer certaines annotations (ou toutes), il suffit de les filtrer au moment de leur récupérer par getAnnotations. L’extrait de code ci-dessous illustre ce fonctionnement pour les titres :

/**
 * When we encounter a new header, we create an annotation for it.
 */
public void beginHeader(int headerLevel, WikiParameters params) {
  // Jump a line
  addToContent("\n\n");
  // Create the annotation
  Header header = new Header(theCas);
  header.setLevel(headerLevel);
  header.setBegin( theOffset );
  // Add it to the list
  theHeadersAnnotations.add( header );
  // Add it as header of the last unclosed section
  if ( theUnclosedSections.size() > 0 ) {
    Section section = theUnclosedSections.get( theUnclosedSections.size()-1 );
    section.setTitle(header);
  }
}
 
/**
 * Add the ending value of the last started header.
 */
public void endHeader(int headerLevel, WikiParameters params) {
  // Retrieve the last header
  Header header = theHeadersAnnotations.get( theHeadersAnnotations.size()-1 );
  // Update its ending value
  header.setEnd( theOffset );
  // Jump a line
  addToContent("\n\n");
}

Je me suis rendu compte que le parseur posait des problèmes (heap overflow) sur des pages de certains espaces de noms. J’ai donc choisi de n’appliquer l’analyse syntaxique qu’aux pages de l’espace de nom 0 (espace de nom principal). Ceci est toutefois facilement modifiable dans la méthode uima.wikipedia.mwdumper.ThreadedMWDumper.writeStartPage.

Il reste pas mal d’améliorations possibles : prendre en compte toutes les mises en formes/structurations, prendre en charge les macros, rendre l’analyse syntaxique configurable. Toutefois, le composant est dans l’état actuel aussi complet et performant que je le souhaitais à l’origine. Il ne reste plus qu’à le tester de manière intensive. J’ai d’ailleurs deux trois cobayes en tête pour ça.

Nouvelle version du composant

Pas de nouvelle version du composant pour l’instant. Étant donné que les dépendances se sont multipliées, et que le composant est désormais suffisamment fonctionnel pour se voir estampillé 1.0 ou quelque chose du genre, je vais travailler un peu plus son packaging.

Autres articles

Retour au sommaire

UIMA & Wikipédia (3) : Filtrage des données à charger

0 vote

Par Fabien Poulard le 12/02/2010 à 00:00

Voici le troisième billet qui discute du filtrage des données à charger : articles, révision, ...

Filtres de MWDumper

L’outil mwdumper inclut un certain nombre de filtres commandables à partir de la ligne de commande :

LatestFilter permet de ne conserver que la dernière révision d’une page ;
NamespaceFilter permet de ne conserver que les articles qui appartiennent à un espace de nom particulier (passé en paramètre) ;
NotalkFilter permet d’ignorer les pages de discussion ;
TitleMatchFilter permet de ne conserver que les pages dont le titre valide une expression rationnelle donnée en paramètre ;
ListFilter permet de ne conserver que les pages dont le titre de la page de données ou de discussion est présent dans un fichier passé en paramètre (un nom de page par ligne) ;
ExactListFilter est identique au filtre précédent si ce n’est que son application est plus stricte car seul le titre de la page est considéré ;
RevisionListFilter reprend le principe des filtres précédents si ce n’est qu’il s’applique aux identifiants de révisions ;
BeforeTimeStampFilter ne conserve que les données produites avant une date passée en paramètre ;
AfterTimeStampFilter ne conserve que les données produites après une date passée en paramètre ;

Voir le billet Insérer plusieurs copies locales de Wikipedia dans une base PostgreSQL pour un cas d’utilisation de ces filtres. La combinaison de ces filtres permet de contrôler avec précision les données à charger, nous allons donc nous en contenter.

Paramétrage du composant

On peut classer les filtres en deux familles : ceux qui nécessitent des paramètres et ceux qui n’en nécessitent pas. J’ai donc choisi pour le moment d’utiliser des paramètres booléens pour les filtres sans paramètre, et des paramètres chaînes de caractères pour les autres.

L’activation des paramètres booléens suffit à activer les filtres correspondant : IgnoreTalks et LatestRevisionOnly.

Pour activer les autres filtres il suffit de les configurer en renseignant les champs dédiés. Si les champs restent non renseignés alors les filtres ne sont pas activés : ConfigNamespacesFilter, ConfigTitleMatch, ConfigListFilter, ConfigExactListFilter, ConfigRevisionListFilter, ConfigBeforeTimestampFilter, ConfigAfterTimestampFilter.

Nouvelle version

Voici une nouvelle version du collection reader pour Wikipédia, estampillée 0.2, qui ne prend toujours pas en compte la syntaxe, mais qui permet de filtrer le type de contenu à charger à partir du dump XML. Pour utiliser le composant, il est nécessaire d’avoir le jar de mwdumper dans le classpath.

Autres articles

Retour au sommaire

UIMA & Wikipédia (2) : Chargement d'un dump Wikipedia

0 vote

Par Fabien Poulard le 02/02/2010 à 00:00

Voici le second billet qui discute du chargement d’un dump XML de l’encyclopédie libre et la distribution du contenu sous forme de CAS.

Wikipédia, formats brutes

La base de données contenant toutes les pages de Wikipédia et autre sites de la fondation WikiMedia est automatiquement archivée très régulièrement. Les dumps de la base sont disponibles sur http://download.wikimedia.org/. Vous trouverez ainsi :

les archives de la Wikipédia française
les archives de WikiNews ou juste la partie en français
les archives de la Wikiversity ou juste la partie en français
les archives des WikiBooks

Il est également possible de télécharger l’intégralité de l’encyclopédie dépourvue des balises wiki : http://download.wikimedia.org/nowiki/.

Le billet Créer un miroir Wikipédia explique comment construire une copie locale de l’encyclopédie à partir de ces différents dumps. Nous nous donnons comme objectif d’exploiter ces dumps directement sans passer par une importation en base de données.

L’outil d’exportation et d’importation de MediaWiki : mwdump

MWDumper est un outil écrit en Java par les développeurs de MediaWiki qui permet d’importer/exporter une base MediaWiki à partir de/vers une base de données. Cet outil a l’avantage de travailler directement sur la version compressée du dump XML, réduisant ainsi le besoin en espace disque disponible. Cet outil s’utilise en ligne de commande et offre un certain nombre de paramètres permettant notamment de filtrer les articles à exporter ou bien le format SQL à prendre en charge.

Une version compilée de l’outil est disponible sur download.wikipedia.org, mais il y a de forte chance qu’elle soit dépassée. Le plus sûr est de compiler l’outil depuis les sources.

Une partie du code de cet outil va nous faciliter la tâche pour la réalisation d’un collection reader pour UIMA, notamment les classes :

org.mediawiki.importer.XmlDumpReader
org.mediawiki.importer.DumpWriter
org.mediawiki.importer.Page
org.mediawiki.importer.Revision

Il nous faut toutefois noter que XmlDumpReader repose sur un analyseur SAX, ce qui n’est pas directement utilisable dans un Collection Reader d’UIMA. En effet, dans UIMA c’est le Collection Reader qui contrôle l’exécution, alors qu’à l’opposé l’analyseur SAX contrôle sa propre exécution. La seule interaction avec le parseur est l’emploi des hooks.

L’idée est de faire tourner l’analyseur SAX dans un thread différent de celui du collection reader. Ensuite à l’aide d’un mécanisme de sémaphore (ou de monitor en Java), on contrôle l’exécution du parseur pour produire les CAS. Cette méthode permet d’utiliser presque directement l’outil de MediaWiki, ainsi si la syntaxe évolue, l’outil de MediaWiki évoluera également certainement et ce sera donc normalement transparent pour le collection reader.

Une première version de collection reader pour Wikipedia

Voici une première version du collection reader pour Wikipédia qui ne prend pas du tout en compte la syntaxe, mais charge seulement le contenu des pages dans un CAS. Il y a encore beaucoup de travail pour obtenir quelque chose d’intéressant et d’utilisable, d’où l’estampillage 0.1. Pour utiliser le composant, il est nécessaire d’avoir le jar de mwdumper dans le classpath.

Il y a tout un tas d’améliorations que j’aimerais apporter (filtrage, analyse de la syntaxe wiki, ...) mais l’idée est dans un premier temps de fournir une version brute de fonderie qui fonctionne pour qu’elle puisse être testée. Le jar contient notamment le code Java, donc il ne faut pas hésiter à y jeter un oeil.

Le descripteur est dans le Jar distribué, il ne prend en paramètre que le chemin vers le dump XML à charger. Peu importe l’extension (.gz, .bz, ...), il devrait pouvoir s’en sortir. Si ce n’est pas le cas, laissez un commentaire ! Je n’ai fait que peu de tests pour le moment, je ne sais pas trop comment le composant tient la route sur des gros dumps, mais la première remarque est qu’il est nécessaire d’augmenter la taille du tas de la jvm (-Xmx=512m pour commencer). En effet, certaines pages sont assez imposantes de par leur grand nombre de révisions, et pour l’instant toutes les révisions sont chargées dans chaque CAS.

Autres billets

Retour au sommaire

UIMA & Wikipédia (1) : Proposition de Type System

0 vote

Par Fabien Poulard le 01/02/2010 à 00:00

Voici le premier billet qui discute de la création d’un Type System approprié pour représenter les pages de Wikipedia.

Wikipédia, structuration des données

L’encyclopédie Wikipédia contient tout un tas d’informations mais je me concentrerai particulièrement sur le contenu même : les articles. Je propose de classer les informations concernant ces derniers en quatre grandes catégories :

Position de l’article dans l’encyclopédie (portail, catégories, ...)
Versions de l’article (révisions, ...)
Structuration de l’article (titre, sous-titre, ...)
Macros et mise en forme du texte (gras, italique, ...)

Position de l’article dans l’encyclopédie

On peut considérer la Wikipédia comme un ensemble de pages liées selon trois grandes relations :

Les catégories structurent l’encyclopédie à la manière d’une ontologie ou d’un thésaurus. Une page peut appartenir à une ou plusieurs catégories. De plus, les catégories sont hiérarchisées, l’appartenance à une catégorie implique l’appartenance à toutes les catégories parentes.

Les liens interlangues marquent les pages en relation de traduction avec la page courante.

Les liens internes permettent au sein d’une page de faire référence à d’autres pages de l’encyclopédie, il s’agit d’une structuration qui n’a qu’un impact local. La signification de ces références est très variable et difficilement identifiable.

Versions de l’article

Le principe de l’encyclopédie collaborative est que tout le monde peut modifier un article, ce qui amène à de multiples révisions de ces derniers. Lorsque vous cliquez sur l’onglet Historique d’un article, vous pouvez visionner ces différentes révisions, leur auteur, et éventuellement un commentaire précisant l’apport de la révision.

Structuration d’un article

Le contenu d’un article se structure à l’aide de titres, de paragraphes ainsi que de divers éléments de mise en forme : [tableaux], [formules], [listes], ...

Parmi les éléments de mise en forme, on peut également noter l’existence de plusieurs macros pour les [modèles], [dates], [liens interwiki], ...

Choix d’un Type System

Je ne crois personnellement pas à l’existence de Type Systems génériques pouvant être partagés par tous les composants. De mon point de vue, un Type System va être approprié au traitement d’une tâche particulière, chercher à en produire un suffisamment générique pour toutes les tâches seraient une perte de temps et mènerait certainement à un TS difficile à utiliser.

Personnellement, je vais utiliser Wikipedia dans le cadre de ma thèse sur la détection de dérivation de texte. Ce qui m’intéresse c’est donc de générer un CAS par article dans lequel on retrouvera les différentes révisions dudit article. Je m’intéresse donc :

à la notion d’article
aux notions de révision
à la structuration du contenu d’un article à l’aide des titres et des paragraphes
au texte

Après réflexion j’en suis donc arrivé à cette modélisation :

Cette modélisation ne correspond pas exactement aux besoins d’un TS UIMA. Ainsi, les relations de composition se manifestent par un phénomène de couverture des annotations, entraînant la disparition des attributs correspondant.

Vous trouverez le descripteurs correspondant à ce TS ici.

Autres billets

Retour au sommaire

Sortie d'Apache UIMA 2.3

0 vote

Par Fabien Poulard le 29/01/2010 à 00:00

L’annonce est parue hier sur les listes concernées, la nouvelle version du framework Apache UIMA (Unstructured Information Management Architecture) est sortie, estampillée 2.3 !

Au programme de cette nouvelle version, beaucoup de corrections de bug come d’habitude, mais surtout l’intégration de UIMA-AS qui permet une meilleure distribution des calculs entre plusieurs serveurs et l’ajout de plusieurs addons :

Bean Scripting Framework qui va permettre d’écrire des annotateurs dans plusieurs langages de script ;
Lucas qui permet d’interfacer UIMA avec Apache Lucene
TikaAnnotator qui fait également parti du projet Apache Lucene et qui permet tout simplement de charger un grand nombre de formats de fichiers (html, xml, Microsoft Office, pdf, rtf ainsi que des formats audio et vidéo).

Cette nouvelle mouture d’UIMA tire désormais parti des génériques de Java 5, ce qui va permettre de limiter les casting aventureux pour récupérer les annotations, itérateurs, ... :) Cela signifie toutefois que la version 5 de Java est désormais le requis minimum pour utiliser UIMA.

Vous trouverez plus de détails sur cette version dans les notes de release :

Retour au sommaire

Informations

Abonnement

Membres

Participer

Accès rapide aux derniers articles de la page

Utilisation du subiterator

Utilisation des contraintes (FSMatchConstraint)

Principe de UUTUC

Écriture de tests unitaires

Intégration avec Maven

Avant propos

Initialiser un projet

Ajouter des annotations manuellement

Utiliser un AE pour ajouter des annotations

Construction et installation du PEAR

Visualiser et modifier les annotations

Présentation du composant

Installation

Utilisation

Qu’est-ce que Maven ?

Récupérer les dépendances

Écriture du pom.xml

Mettre en place un dépôt pour les dépendances

Déployer le composant sur le dépôt

Connexion automatique par ssh

Déclaration du dépôt dans le pom.xml

Modalités de connexion au dépôt

Déploiement

Extensions possibles

Nouvelle version du composant

Autres articles

Analyse syntaxique des pages MediaWiki

WikiModel pour MediaWiki

Nouvelle version du composant

Autres articles

Filtres de MWDumper

Paramétrage du composant

Nouvelle version

Autres articles

Wikipédia, formats brutes

L’outil d’exportation et d’importation de MediaWiki : mwdump

Une première version de collection reader pour Wikipedia

Autres billets

Wikipédia, structuration des données

Position de l’article dans l’encyclopédie

Versions de l’article

Structuration d’un article

Choix d’un Type System

Autres billets