ITA Controlled English (CE) is een gestructureerde taal die bedoeld is om concepten, eigenschappen en relaties op een manier te definiëren die zowel voor mensen als machines begrijpelijk is.
Het project CE Store, geïnitieerd door IBM, biedt een open-source experimentele onderzoeksomgeving voor deze taal. In een CE-model worden concepten gedefinieerd via specifieke zinnen, waarna concrete instanties van deze concepten kunnen worden aangemaakt.
De CE Store kan op verschillende manieren worden geïmplementeerd:
- Via IBM Cloud voor een automatisch beheerde instantie.
- Lokaal via Apache Maven, Docker of Vagrant.
Gebruikers kunnen de omgeving beheren via het Engineering Panel, een webinterface waarmee modellen kunnen worden geladen, gewijzigd en bevraagd.
ITA Controlled English (CE)
De CE Store bevat alles wat nodig is om te beginnen met een Controlled English-omgeving. Het is een door IBM geïnitieerd open-source project dat zich richt op het bieden van een experimentele onderzoeksomgeving voor de ITA Controlled English-taal.
Snel voorbeeld
Een CE-model bevat alle informatie over de gegevens die in de CE Store zijn geladen. Het is opgebouwd uit zinnen die concepten en instanties bevatten.
- Een zin eindigt altijd met een punt.
- Een concept definieert een ding.
- Een instantie is een enkele voorkoming van dat concept/ding.
Een voorbeeld van een zin die een concept in CE definieert, is als volgt: conceptualise a ~ planet ~ P that has the value M as ~ mass ~ and has the value R as ~ radius ~.
Vervolgens kunnen we een instantie van een planeet genaamd 'Earth' definiëren met een andere CE-zin: there is a planet named 'Earth' that has '5.972 × 10^24' as mass and has 6371 as radius.
Voor meer gedetailleerde voorbeelden kan men terecht in de sectie 'Tutorials' van de wiki of een video bekijken voor een gedetailleerd overzicht met voorbeelden (22 minuten en 48 seconden).
Snelgids
De volgende onderwerpen zijn beschikbaar in de gids:
- Installatie en configuratie
- Gebruik
- Tutorials
- API
- Cheatsheet
- Opdrachtsyntaxis (Command Syntax)
- Hudson
- Andere projecten
- Bijdragen
Installatie en configuratie
Gebruik van CE in IBM Cloud
Een eenvoudige manier om te beginnen met Controlled English is via IBM Cloud. Je kunt je gratis aanmelden voor IBM Cloud. Zodra je een account hebt, kan een Cloud-gehoste instantie van je eigen CE Store automatisch worden geïmplementeerd.
Belangrijke opmerking: Na implementatie in IBM Cloud vindt u uw ce-store terug op http://(uw IBM Cloud url)/ce-store/ in plaats van in de root van de IBM Cloud url. Om de ce-store via het engineeringpanel te openen, navigeert u daarom naar http://(uw IBM Cloud url)/ce-store/ui/.
CE draaien op je eigen machine
De code klonen
git clone https://github.com/ce-store/ce-store
Gebruik van Apache Maven
Gebruik Apache Maven om de CE Store-applicatie op te starten met een ingebedde Tomcat-server via de volgende commando's:
mvn install
mvn tomcat:run
De CE Store is vervolgens beschikbaar op de volgende URL: http://localhost:8080/ce-store
Gebruik van Docker
docker pull cestore/ce-store
docker run --rm -it -p 8080:8080 cestore/ce-store
Bouwen met Docker
Gebruik Apache Maven om een WAR-bestand voor het project te bouwen met het volgende commando:
mvn package
Dit WAR-bestand kan vervolgens worden omgezet in een Docker-image met het onderstaande commando:
docker build -t ce-store .
Start daarna de container vanaf deze image op je lokale machine:
docker run --rm -it -p 8080:8080 ce-store
De CE Store is vervolgens beschikbaar op de volgende URL: http://localhost:8080/ce-store
Gebruik van Vagrant
Hiervoor moet Vagrant geïnstalleerd zijn.
vagrant up
vagrant ssh
cd /vagrant
Volg daarna de stappen onder het kopje "Gebruik van Apache Maven".
Gebruik
Engineering Panel
Het Engineering Panel biedt een eenvoudige webinterface voor de CE Store. Hiermee kan de gebruiker de inhoud van de CE Store bekijken, nieuwe CE-zinnen laden, queries uitvoeren op de store, en meer.
Om het Engineering Panel te openen, ga naar: <SERVER>/ce-store/ui.
Het engineeringpanel bestaat uit vier hoofdonderdelen:
- [Links] Model operations: CE-modellen kunnen worden geladen en gewijzigd.
- [Rechts] Object pane: De inhoud van een CE-store kan worden bekeken.
- [Onderaan] Messages: Hier worden fouten gemeld.
- [Midden] Working area: Interacties met het model.
De CE Store wordt geleverd met een voorbeeldset van CE-zinnen om een model over medische gegevens te bouwen. De wiki bevat een tutorial voor het gebruik van dit "Medicine model".
Bijdragen
Informatie over het bijdragen aan dit project is hier te vinden.
Licentie
Dit project is gelicenseerd onder de Apache License, Versie 2.0.
ITA Controlled English (CE)
De CE Store bevat alles wat nodig is om te beginnen met een Controlled English-omgeving. Het is een door IBM geïnitieerd open-source project dat zich richt op het bieden van een experimentele onderzoeksomgeving voor de ITA Controlled English-taal.
Snel voorbeeld
Een CE-model bevat alle informatie over de gegevens die in de CE Store zijn geladen. Het is opgebouwd uit zinnen die concepten en instanties bevatten.
- Een zin eindigt altijd met een punt.
- Een concept definieert een ding.
- Een instantie is een enkele voorkoming van dat concept/ding.
Een voorbeeld van een zin die een concept in CE definieert, is als volgt: conceptualise a ~ planet ~ P that has the value M as ~ mass ~ and has the value R as ~ radius ~.
Vervolgens kunnen we een instantie van een planeet genaamd 'Earth' definiëren met een andere CE-zin: there is a planet named 'Earth' that has '5.972 × 10^24' as mass and has 6371 as radius.
Voor meer gedetailleerde voorbeelden kan men terecht in de sectie 'Tutorials' van de wiki of een video bekijken voor een gedetailleerd overzicht met voorbeelden (22 minuten en 48 seconden).
Snelgids
De volgende onderwerpen zijn beschikbaar in de gids:
- Installatie en configuratie
- Gebruik
- Tutorials
- API
- Cheatsheet
- Opdrachtsyntaxis (Command Syntax)
- Hudson
- Andere projecten
- Bijdragen
Installatie en configuratie
Gebruik van CE in IBM Cloud
Een eenvoudige manier om te beginnen met Controlled English is via IBM Cloud. Je kunt je gratis aanmelden voor IBM Cloud. Zodra je een account hebt, kan een Cloud-gehoste instantie van je eigen CE Store automatisch worden geïmplementeerd.
Belangrijke opmerking: Na implementatie in IBM Cloud vindt u uw ce-store terug op http://(uw IBM Cloud url)/ce-store/ in plaats van in de root van de IBM Cloud url. Om de ce-store via het engineeringpanel te openen, navigeert u daarom naar http://(uw IBM Cloud url)/ce-store/ui/.
CE draaien op je eigen machine
De code klonen
git clone https://github.com/ce-store/ce-store
Gebruik van Apache Maven
Gebruik Apache Maven om de CE Store-applicatie op te starten met een ingebedde Tomcat-server via de volgende commando's:
mvn install
mvn tomcat:run
De CE Store is vervolgens beschikbaar op de volgende URL: http://localhost:8080/ce-store
Gebruik van Docker
docker pull cestore/ce-store
docker run --rm -it -p 8080:8080 cestore/ce-store
Bouwen met Docker
Gebruik Apache Maven om een WAR-bestand voor het project te bouwen met het volgende commando:
mvn package
Dit WAR-bestand kan vervolgens worden omgezet in een Docker-image met het onderstaande commando:
docker build -t ce-store .
Start daarna de container vanaf deze image op je lokale machine:
docker run --rm -it -p 8080:8080 ce-store
De CE Store is vervolgens beschikbaar op de volgende URL: http://localhost:8080/ce-store
Gebruik van Vagrant
Hiervoor moet Vagrant geïnstalleerd zijn.
vagrant up
vagrant ssh
cd /vagrant
Volg daarna de stappen onder het kopje "Gebruik van Apache Maven".
Gebruik
Engineering Panel
Het Engineering Panel biedt een eenvoudige webinterface voor de CE Store. Hiermee kan de gebruiker de inhoud van de CE Store bekijken, nieuwe CE-zinnen laden, queries uitvoeren op de store, en meer.
Om het Engineering Panel te openen, ga naar: <SERVER>/ce-store/ui.
Het engineeringpanel bestaat uit vier hoofdonderdelen:
- [Links] Model operations: CE-modellen kunnen worden geladen en gewijzigd.
- [Rechts] Object pane: De inhoud van een CE-store kan worden bekeken.
- [Onderaan] Messages: Hier worden fouten gemeld.
- [Midden] Working area: Interacties met het model.
De CE Store wordt geleverd met een voorbeeldset van CE-zinnen om een model over medische gegevens te bouwen. De wiki bevat een tutorial voor het gebruik van dit "Medicine model".
Bijdragen
Informatie over het bijdragen aan dit project is hier te vinden.
Licentie
Dit project is gelicenseerd onder de Apache License, Versie 2.0.
Groetjes,