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 21:26:34 UTC
svn commit: r1409984 -
/incubator/ctakes/site/trunk/content/ctakes/2.6.0/user-guide-2.6.mdtext
Author: bleeker
Date: Thu Nov 15 20:26:34 2012
New Revision: 1409984
URL: http://svn.apache.org/viewvc?rev=1409984&view=rev
Log:
CMS commit to ctakes by bleeker
Modified:
incubator/ctakes/site/trunk/content/ctakes/2.6.0/user-guide-2.6.mdtext
Modified: incubator/ctakes/site/trunk/content/ctakes/2.6.0/user-guide-2.6.mdtext
URL: http://svn.apache.org/viewvc/incubator/ctakes/site/trunk/content/ctakes/2.6.0/user-guide-2.6.mdtext?rev=1409984&r1=1409983&r2=1409984&view=diff
==============================================================================
--- incubator/ctakes/site/trunk/content/ctakes/2.6.0/user-guide-2.6.mdtext (original)
+++ incubator/ctakes/site/trunk/content/ctakes/2.6.0/user-guide-2.6.mdtext Thu Nov 15 20:26:34 2012
@@ -18,12 +18,12 @@ Notice: Licensed to the Apache Softwa
#This page is under construction
-#cTAKES 3.0 User Guide
+#cTAKES 2.6 User Guide
cTAKES users are those who wish to use cTAKES as it is without code modifications.
With these instructions you can install cTAKES, configure it, and use it to process text.
cTAKES is built around analysis of text associated with a medical record. If you were planning to expand, change, or modify the
-code within cTAKES, refer to the [cTAKES 3.0 Developer Guide](/3.0.0/developer-guide-3.0).
+code within cTAKES, refer to the [cTAKES 2.6 Developer Guide](/2.6.0/developer-guide-2.6).
There are GUIs for the configuration and viewing of results, however, there are no summaries, statistics, or pretty graphs.
The results are lots of annotations recorded in [UIMA XMI files](http://uima.apache.org/downloads/releaseDocs/2.1.0-incubating/docs/html/tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.xmi_emf).
@@ -45,11 +45,11 @@ installed. Run this command to check you
<pre>
java -version
</pre>
-2. Download the [**cTAKES-3.0.zip**](NotYetAvailable) file.
+2. Download the [**cTAKES-2.6.zip**](NotYetAvailable) file.
Save the file to a temporary location on your machine.
3. Unzip the ZIP file into a directory that you want to be the cTAKES installed home directory.
-This directory we will call **<cTAKES_HOME>**. You will need to refer to this later. **Windows**: <code>c:\cTAKES-3.0</code> **Linux**: <code> /usr/bin/cTAKES-3.0</code>
+This directory we will call **<cTAKES_HOME>**. You will need to refer to this later. **Windows**: <code>c:\cTAKES-2.6</code> **Linux**: <code> /usr/bin/cTAKES-2.6</code>
## Process documents using cTAKES
@@ -65,7 +65,7 @@ is to let you browse all the data that i
Components are also called an "analysis engine" as they can be made up of multiple annotators.
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>
+**Windows**: <code>cd \cTAKES-2.6</code> **Linux**: <code>cd /usr/bin/cTAKES-2.6</code>
**Note:** <cTAKES_HOME> must be your current directory unless you are skilled at setting
paths on your machine.
@@ -122,7 +122,7 @@ Text frame on the right.
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**: <code>cd \cTAKES-3.0</code> **Linux**: <code>cd /usr/bin/cTAKES-3.0</code>
+**Windows**: <code>cd \cTAKES-2.6</code> **Linux**: <code>cd /usr/bin/cTAKES-2.6</code>
**Note:** <cTAKES_HOME> must be your current directory unless you are skilled at setting
paths on your machine.
@@ -147,7 +147,7 @@ was just a test you may click the **No**
### Validate CPE Results
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>
+**Windows**: <code>cd \cTAKES-2.6</code> **Linux**: <code>cd /usr/bin/cTAKES-2.6</code>
2. To test the results, you will use a comparison tool that will help show that the
results match expectations. Enter this command:
@@ -156,7 +156,7 @@ java -cp cTAKES.jar edu.mayo.bmi.utils.x
</pre>
Where: **_<First File>_** is the first file to compare; **_<Second File>_** is
the second file to compare; **_<diff-html>_** is where the results are written
-to. For example:
+to. For example:
**Windows**:
<pre>
java -cp cTAKES.jar edu.mayo.bmi.utils.xcas_comparison.Compare ^
@@ -197,7 +197,7 @@ following table.
## Next Steps
-The [cTAKES 3.0 Component Use Guide](3.0.0/component-use-guide-3.0) will help you to
+The [cTAKES 2.6 Component Use Guide](2.6.0/component-use-guide-2.6) will help you to
understand in great detail each of the cTAKES components that have been
installed. In some cases you can learn how to improve the components. However,
before you go on to process text in production you will need to consider
@@ -292,8 +292,8 @@ the cTAKES forums:
### Models
Some models included in cTAKES may not represent your data distribution well.
-If you want to build or train your own models, please read the [cTAKES 3.0
-Component Use Guide](3.0.0/component-use-guide-3.0),
+If you want to build or train your own models, please read the [cTAKES 2.6
+Component Use Guide](2.6.0/component-use-guide-2.6),
particularly:
* [Training a sentence detector model](NotYet Available)