You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ctakes.apache.org by bl...@apache.org on 2012/11/15 18:41:53 UTC
svn commit: r1409895 -
/incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext
Author: bleeker
Date: Thu Nov 15 17:41:52 2012
New Revision: 1409895
URL: http://svn.apache.org/viewvc?rev=1409895&view=rev
Log:
CMS commit to ctakes by bleeker
Modified:
incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext
Modified: incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext
URL: http://svn.apache.org/viewvc/incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext?rev=1409895&r1=1409894&r2=1409895&view=diff
==============================================================================
--- incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext (original)
+++ incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext Thu Nov 15 17:41:52 2012
@@ -74,7 +74,7 @@ paths on your machine.
**Windows**: <code>runctakesCVD.bat</code> **Linux**: <code>runctakesCVD.sh</code>
3. An analysis engine (AE) needs to be loaded in order to process text.
-Use the **Run** -> **Load AE** menu bar command. Navigate to the file. Click **Open**.
+Use the **Run** -> **Load AE** menu bar command. Navigate to the file: <code><cTAKES_HOME>/cTAKESdesc/cdpdesc/analysis_engine/AggregatePlaintextProcessor.xml</code> Click **Open**.
4. Copy the text in this example and paste the contents into the Text section of CVD, replacing the text that is already
there. This example file can also be found in test data: <code><cTAKES_HOME>/testdata/cdptest/testinput/plaintext/testpatient_plaintext_1.txt</code>
@@ -110,81 +110,44 @@ and
edu.mayo.bmi.uima.core.type.textsem.EventMention
edu.mayo.bmi.uima.core.type.textsem.EventMention.MedicationEventMention
</pre>
-
-Then select **edu.mayo.bmi.uima.core.type.****textsem.****EntityMention** or *
+7. Then select **edu.mayo.bmi.uima.core.type.****textsem.****EntityMention** or *
*edu.mayo.bmi.uima.core.type.****textsem.****EventMention.****Medication****Ev
entMention**.This will show an Annotation Index in the lower frame. Select any
annotation in that lower frame and you will see the text discovered in the
-Text frame on the right. You may close CVD if you wish.
+Text frame on the right.
### Collection processing engine (CPE)
The [Collection Processing Engine (CPE) Configuration GUI](http://uima.apache.org/downloads/releaseDocs/2.2.2-incubating/docs/html/tools/tools.html#ugr.tools.cpe) is for configuring components (aka analysis engine) to process documents (called a pipeline).
-1. Open a command prompt and change to the cTAKES_HOME directory:
-
-**Windows**:
-
-
-**Linux**:
-
-
-
-**Note**
-
-Note that cTAKES_HOME must be your current directory unless you are skilled at
-setting paths on your machine.
-
-2. Start the collection processing engine by running this command:
-
-**Windows**:
+1. Open a command prompt and change to the cTAKES_HOME directory.
+**Windows**: <code>cd \cTAKES-3.0</code> **Linux**: <code>cd /usr/bin/cTAKES-3.0</code>
+
+**Note:** cTAKES_HOME must be your current directory unless you are skilled at setting
+paths on your machine.
-
-**Linux**:
-
-
-The application may take a minute to start on slower hardware.
-
-
+2. Start the Collection Processing Engine (CPE) by running this command. The application may take a minute to start on slower hardware:
+**Windows**: <code>runctakesCPE.bat</code> **Linux**: <code>runctakesCPE.sh</code>
3. This will bring up the Collection Processing Engine Configurator. In the
-Menu bar click **File** > **Open CPE Descriptor**
-
-
-
-4. Navigate to the file
+Menu bar click **File** > **Open CPE Descriptor**.
-Click **Open**.
-
-
+4. Navigate to the file: <code><cTAKES_HOME>/cTAKESdesc/cdpdesc/collection_processing_engine/test_plaintext.xml</code> Click **Open**.
5. Click the Play button (green/blue **play arrow** near the bottom).
-
-
-6. You should see that one document was processed. You did process a
-collection of documents. In this case the collection only contained one just
-to show how to do it. Close the results window.
-
-
+6. You should see that one document was processed. A collection of documents was processed, however,
+in this case, the collection only contained one just
+to show how to do it.
+Close the results window.
7. Close the CPE application. You may be prompted to save changes. Since this
was just a test you may click the **No** button.
-
-
-8. Open a new command prompt and change to the <cTAKES_HOME>
-
-No example.
+8. Open a new command prompt and change to the <cTAKES_HOME> directory.
-9. To test the results there is a comparison tool that will help show that the
+9. To test the results, you will use a comparison tool that will help show that the
results match expectations with the following syntax:
Where: **_<First File>_** is the first file to compare; **_<Second File>_** is