You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ctakes.apache.org by bu...@apache.org on 2012/11/14 20:35:12 UTC
svn commit: r838358 - in /websites/staging/ctakes/trunk/content: ./
ctakes/3.0.0/user-guide-3.0.html
Author: buildbot
Date: Wed Nov 14 19:35:11 2012
New Revision: 838358
Log:
Staging update by buildbot for ctakes
Modified:
websites/staging/ctakes/trunk/content/ (props changed)
websites/staging/ctakes/trunk/content/ctakes/3.0.0/user-guide-3.0.html
Propchange: websites/staging/ctakes/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Nov 14 19:35:11 2012
@@ -1 +1 @@
-1409283
+1409318
Modified: websites/staging/ctakes/trunk/content/ctakes/3.0.0/user-guide-3.0.html
==============================================================================
--- websites/staging/ctakes/trunk/content/ctakes/3.0.0/user-guide-3.0.html (original)
+++ websites/staging/ctakes/trunk/content/ctakes/3.0.0/user-guide-3.0.html Wed Nov 14 19:35:11 2012
@@ -86,14 +86,13 @@
<h1 id="this-page-is-under-construction">This page is under construction</h1>
<h1 id="ctakes-30-user-guide">cTAKES 3.0 User Guide</h1>
<p>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 (typically text associated
-with a medical record). If you were planning to expand, change, or modify the
-code within cTAKES, refer to the <a href="">cTAKES 3.0 Developer Install
-Instructions</a>.</p>
-<p>At present there is no GUI through which you can utilize the results of cTAKES processing.
-The available GUIs are for launching the text or document processing (called a pipeline).
-The results ...</p>
+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 <a href="/3.0.0/developer-guide-3.0">cTAKES 3.0 Developer Guide</a>.</p>
+<p>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 <a href="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">UIMA XMI files</a>.
+You can see and sift through the results, but more processing is required to reap the benefits of the processing.
+The process that you set up to do these annotations is called a pipeline.</p>
<p>These instructions will cover installation and a test of the main product
including trained models for sentence detection and tagging parts of speech,
dictionaries from a subset of the UMLS, a very small subset of the full LVG
@@ -101,22 +100,22 @@ resource, etc. Optional components will
<p>Once you have finished installation of cTAKES, you will be able to see what
cTAKES is capable of. Further exploitation of the software's ability may
require following a few additional steps involving what dictionaries are being
-used. These are the last steps in these instructions.</p>
+used.</p>
<h2 id="prerequisites">Prerequisites</h2>
-<p>Make sure you have Java 1.6 or higher. Many systems come with Java already
-installed. Run this command to check your version, for example:</p>
-<div class="codehilite"><pre>C:\>java -version
-java version "1.6.0_20"
-Java(TM) SE Runtime Environment (build 1.6.0_20-b02)
-Java HotSpot(TM) Client VM (build 16.3-b01, mixed mode, sharing)
+<div class="codehilite"><pre>
</pre></div>
<p>If you do not have Java installed or have an older version then you can install Java from <a href="http://www.java.com/en/download/faq/develop.xml">java.com</a>.</p>
<h2 id="install-ctakes">Install cTAKES</h2>
<ol>
+<li>Make sure you have Java 1.6 or higher. Many systems come with Java already
+installed. Run this command to check your version, for example:
+<pre>
+ C:>java -version
+</pre></li>
<li>
-<p>Download the <a href=""><strong>cTAKES-3.0.zip</strong></a> file.
+<p>Download the <a href="NotYetAvailable"><strong>cTAKES-3.0.zip</strong></a> file.
Save the file to a temporary location on your machine.</p>
</li>
<li>
@@ -124,7 +123,7 @@ Save the file to a temporary location on
This folder we will call <strong>cTAKES_HOME</strong>. You will need to refer to the directory later.</p>
</li>
</ol>
-<h4 id="windows"><strong>Windows</strong>:</h4>
+<h5 id="windows"><strong>Windows</strong>:</h5>
<div class="codehilite"><pre><span class="n">c:</span><span class="o">\</span><span class="n">cTAKES</span><span class="o">-</span><span class="mf">3.0</span>
</pre></div>
@@ -135,15 +134,14 @@ This folder we will call <strong>cTAKES_
<h2 id="process-documents-using-ctakes">Process documents using cTAKES</h2>
-<p>This version allows you to test most components bundled in cTAKES in two
+<p>This version allows you to use most components bundled in cTAKES in two
different ways:</p>
<ol>
<li>Using cTAKES CAS Visual Debugger (CVD) to view the results stored as XCAS files or run the annotators or</li>
<li>Using cTAKES collection processing engine (CPE) to process documents in cTAKES_HOME/testdata directory</li>
</ol>
<h3 id="cas-visual-debugger-cvd">CAS Visual Debugger (CVD)</h3>
-<p>Step</p>
-<p>Example</p>
+<p><a href="http://uima.apache.org/downloads/releaseDocs/2.2.2-incubating/docs/html/tools/tools.html#ugr.tools.cvd">CAS Visual Debugger (CVD)</a></p>
<ol>
<li>Open a command prompt and change to the cTAKES_HOME directory.</li>
</ol>
@@ -217,7 +215,8 @@ annotation in that lower frame and you w
Text frame on the right. You may close CVD if you wish.</p>
<p><img alt="screenshot illustrating step" src="/download/attachments/75014322/worddavcfd76769" title="7d1e58970d516f1312a8a6e4.png?version=1&modificationDate=1334686366000" /></p>
<h3 id="collection-processing-engine-cpe">Collection processing engine (CPE)</h3>
-<p>Step</p>
+<p>The <a href="http://uima.apache.org/downloads/releaseDocs/2.2.2-incubating/docs/html/tools/tools.html#ugr.tools.cpe">Collection Processing Engine (CPE) Configuration GUI</a> is for configuring a pipeline to process documents (called a pipeline).
+Step</p>
<p>Example</p>
<ol>
<li>Open a command prompt and change to the cTAKES_HOME directory:</li>