You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by ea...@apache.org on 2008/07/24 23:38:52 UTC

svn commit: r679553 - in /incubator/uima/site/trunk/uima-website/docs: doc-uimaas-what.html documentation.html

Author: eae
Date: Thu Jul 24 14:38:51 2008
New Revision: 679553

URL: http://svn.apache.org/viewvc?rev=679553&view=rev
Log:
UIMA-1126

Added:
    incubator/uima/site/trunk/uima-website/docs/doc-uimaas-what.html
Modified:
    incubator/uima/site/trunk/uima-website/docs/documentation.html

Added: incubator/uima/site/trunk/uima-website/docs/doc-uimaas-what.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/doc-uimaas-what.html?rev=679553&view=auto
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/doc-uimaas-what.html (added)
+++ incubator/uima/site/trunk/uima-website/docs/doc-uimaas-what.html Thu Jul 24 14:38:51 2008
@@ -0,0 +1,355 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+        
+<!-- start the processing -->
+    <!-- ====================================================================== -->
+    <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+    <!-- Main Page Section -->
+    <!-- ====================================================================== -->
+    <html>
+        <head>
+            <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+                                                    <meta name="author" value="
+   UIMA Documentation Team
+  ">
+            <meta name="email" value="uima-dev@incubator.apache.org">
+            
+           
+            
+            
+            
+            
+            
+            <title>Apache UIMA - Getting Started: UIMA Asynchronous Scaleout</title>
+        </head>
+
+        <body bgcolor="#ffffff" text="#000000" link="#525D76">        
+            <table border="0" width="100%" cellspacing="0">
+                <!-- TOP IMAGE -->
+                <tr>
+                    <td align='LEFT'>
+                    <td align="left">
+<a href="http://incubator.apache.org/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
+</td>
+                    </td>
+                    <td align='CENTER'>
+                    <td width="80%" align="center" valign="bottom" bgcolor="#ffffff">
+        <font color="#625972" size="+3" face="arial,helvetica,sanserif">
+    <b>Getting Started: UIMA Asynchronous Scaleout</b>
+</font>
+</td>
+                    </td>
+                    <td align='RIGHT'>
+                    <td align="left">
+<img src="./images/UIMA_banner.png" alt="UIMA project logo" border="0"/>
+</td>
+                    </td>
+                </tr>
+            </table>
+            <table border="0" width="100%" cellspacing="4">
+                <tr><td colspan="2">
+                    <hr noshade="" size="1"/>
+                </td></tr>
+
+                <tr>
+                    <!-- LEFT SIDE NAVIGATION -->
+                    <td width="20%" valign="top" nowrap="true">
+
+                    <!-- special ACon Logo - leave here for next time
+                    <a href="http://apachecon.com/2005/US/">
+                        <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+                             width="125" border="0" alt="ApacheCon US 2005" />
+                    </a>  -->
+
+                   <!-- regular menu -->
+
+                    
+    <!-- ============================================================ -->
+
+                <p><strong>General</strong></p>
+        <ul>
+                    <li>    <a href="./index.html">Home</a>
+</li>
+                    <li>    <a href="./news.html">News</a>
+</li>
+                    <li>    <a href="./documentation.html">Documentation</a>
+</li>
+                    <li>    <a href="./downloads.cgi">Downloads</a>
+</li>
+                    <li>    <a href="./license.html">License</a>
+</li>
+                    <li>    <a href="http://www.apache.org/">ASF</a>
+</li>
+                    <li>    <a href="http://apache.org/foundation/thanks.html">Thanks</a>
+</li>
+                    <li>    <a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+                </ul>
+            <p><strong>Community</strong></p>
+        <ul>
+                    <li>    <a href="./project-guidelines.html">Project Guidelines</a>
+</li>
+                    <li>    <a href="./contribution-policy.html">Contribution Policies</a>
+</li>
+                    <li>    <a href="./get-involved.html">Get Involved</a>
+</li>
+                    <li>    <a href="./team-list.html">Project Team</a>
+</li>
+                    <li>    <a href="./mail-lists.html">Mailing Lists</a>
+</li>
+                    <li>    <a href="./faq.html">FAQ</a>
+</li>
+                    <li>    <a href="http://cwiki.apache.org/UIMA/">Wiki</a>
+</li>
+                    <li>    <a href="./external-resources.html">External UIMA Resources</a>
+</li>
+                </ul>
+            <p><strong>Development</strong></p>
+        <ul>
+                    <li>    <a href="./svn.html">Source Code</a>
+</li>
+                    <li>    <a href="./distribution.html">Creating a Distribution</a>
+</li>
+                    <li>    <a href="./release.html">Doing a UIMA release</a>
+</li>
+                    <li>    <a href="./codeConventions.html">Code Conventions</a>
+</li>
+                    <li>    <a href="http://issues.apache.org/jira/browse/uima ">JIRA</a>
+</li>
+                    <li>    <a href="./uima-specification.html">UIMA Specification</a>
+</li>
+                    <li>    <a href="./sandbox.html">Sandbox</a>
+</li>
+                </ul>
+            <p><strong>Conferences</strong></p>
+        <ul>
+                    <li>    <a href="./gldv07.html">GLDV 2007</a>
+</li>
+                    <li>    <a href="./lrec08.html">LREC 2008</a>
+</li>
+                </ul>
+                        </td>
+                    <td width="80%" align="left" valign="top">
+                                                                      <table border="0" cellspacing="0" cellpadding="2" width="100%">
+        <tr><td bgcolor="#726982">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="Getting Started: UIMA Asynchronous Scaleout"><strong>Getting Started: UIMA Asynchronous Scaleout</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+     The "Getting Started: UIMA Asynchronous Scaleout " guide should help you to understand UIMA AS: how it relates to the core UIMA framework, what are the main concepts of UIMA AS, and an example application scenario.
+   </p>
+                                                      <table border="0" cellspacing="0" cellpadding="2" width="100%">
+  
+ 
+      <tr><td bgcolor="#9289A2">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="UIMA AS Relationship to UIMA"><strong>UIMA AS Relationship to UIMA</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+    UIMA AS is the next generation scalability replacement for the Collection Processing Manager (CPM). UIMA AS provides more flexible and powerful scaleout capability, and extends support to the UIMA components not supported by the CPM, the flow controller and CAS multiplier. UIMA components can be run within UIMA AS with no code or component descriptor changes. 
+   </p>
+                                                <p>
+    UIMA AS introduces a new XML descriptor, the Deployment Descriptor. Unlike the CPM descriptor which specifies component aggregation, error handling and scalability, the UIMA AS Deployment Descriptor only specifies error handling and scalability options; component aggregation is done using the standard aggregate descriptor. The UIMA Component Descriptor Editor (CDE) has been enhanced to support the UIMA AS Deployment Descriptor.
+   </p>
+                                                <p>
+    The UIMA AS binary package includes everything in the standard v2.2.2 SDK package except for core UIMA documentation (links to this documentation on the Apache UIMA website are included). UIMA AS will not work with earlier versions of Apache UIMA. In addition, the UIMA AS package includes the Apache ActiveMQ implementation of JMS which is used to provide connectivity between UIMA AS clients and services.
+   </p>
+                            </blockquote>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                                                      <table border="0" cellspacing="0" cellpadding="2" width="100%">
+  
+ 
+      <tr><td bgcolor="#9289A2">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="UIMA AS Client - Service Architecture"><strong>UIMA AS Client - Service Architecture</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+    Like UIMA Vinci services, UIMA AS provides a service wrapper that creates a shared UIMA service from a UIMA analysis engine. UIMA services enable UIMA clients to utilize UIMA analysis engines running in separate processes on the same or different machines. There are a number of advantages with UIMA AS services:
+    <ol>
+     <li>
+      UIMA AS services are asynchronous. A client can send multiple requests before receiving any responses. This can increase processing throughput over Vinci services which, being synchronous, prevent the client or service from doing work during request/reply transmission.
+     </li>
+     <li>
+      Load balancing for UIMA AS services is excellent, because available services pull requests from a shared queue. Service instances can be dynamically added or removed at runtime
+     </li>
+     <li>
+      Because of Apache ActiveMQ, connectivity to UIMA AS services is much more flexible than Vinci. A maximum of one port needs to be opened to expose one or more services thru a firewall. The HTTP protocol can be used for robust wide-area network connectivity.
+     </li>
+     <li>
+      The UIMA AS design is based on JMS, a widely adopted standard. One goal for UIMA AS is that it can run with different JMS implementations, so that it can be integrated into popular middleware platforms.
+     </li>
+     <li>
+      UIMA AS exposes numerous performance parameters via JMX, extending in a consistent manner the JMX parameters already exposed by core UIMA. Custom UIMA AS monitoring tools based on these JMX parameters are being developed to help identify bottlenecks in complex deployments.
+     </li>
+    </ol>
+   </p>
+                                                <p>
+    The shared queue in front of each UIMA AS service is implemented using an Apache ActiveMQ broker. A separate reply queue is created for each client, and every request contains the address of the client's unique reply queue.
+   </p>
+                                                <p>
+    UIMA AS services are compatible with core UIMA applications such as the Document Analyzer. However, the base UIMA interface to services is synchronous and non-thread safe. There is a new UIMA AS application API that exposes synchronous and asynchronous thread-safe interfaces to UIMA AS services. 
+   </p>
+                                                <p>
+     <table width="100%"><tr><td align="center" valign="middle">
+       <img src="./images/getting-started/uima-as-arch.png" alt="UIMA AS architecture" border="0" />
+       <br>Figure 1 - UIMA AS Client-Server Architecture</br></td>
+      </tr></table>
+   </p>
+                            </blockquote>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                                                      <table border="0" cellspacing="0" cellpadding="2" width="100%">
+  
+ 
+      <tr><td bgcolor="#9289A2">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="UIMA Aggregates vs. UIMA AS Aggregates"><strong>UIMA Aggregates vs. UIMA AS Aggregates</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+    A UIMA aggregate analysis engine is implemented as a synchronous, single-threaded object. That is, when the aggregate AE's process method is called, only one delegate can be working on that CAS at a time. 
+   </p>
+                                                <p>
+    For a UIMA AS aggregate, each delegate has its own input queue, and the aggregate controller sends requests to the delegates via their queues. By default a delegate is assumed to be collocated with the aggregate controller, but the Deployment Descriptor allows a delegate to be "remote", i.e. mapped to the input queue for another UIMA AS service. For collocated delegates, the Deployment Descriptor can specify how many instances of the delegate should be instantiated; each instance will have a listener thread to receive requests and execute user code.
+   </p>
+                                                <p>
+    When calling "remote" delegates, the CAS is serialized into CasXmi format for transfer. Colocated delegates share the in-process CAS object and have no serialization overhead. Remote delegates with no dependency on each others results can be called in parallel on the same CAS, providing opportunities for reducing latency in real-time applications.
+   </p>
+                                                <p>
+    UIMA AS aggregates optionally provide extensive error handling for service calls, including retry, ignore, delegate disable, service termination, and more. When combined with the UIMA flow controller, users can implement complex application flow/error handling logic.
+   </p>
+                                                <p>
+     <table width="100%"><tr><td align="center" valign="middle">
+       <img src="./images/getting-started/async-aggregate.png" alt="UIMA AS asynchronous aggregate" border="0" />
+       <br>Figure 2 - UIMA AS Aggregate</br></td>
+     </tr></table>
+   </p>
+                            </blockquote>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                                                      <table border="0" cellspacing="0" cellpadding="2" width="100%">
+  
+ 
+      <tr><td bgcolor="#9289A2">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="UIMA AS - Example Application Scenario"><strong>UIMA AS - Example Application Scenario</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+    One problem that has been raised on the UIMA mailing lists is how to "push" documents into a UIMA processing pipeline. The simple answer with UIMA AS is to implement the processing pipeline as a UIMA AS service, and push requests from a custom application. Multiple instances of the processing pipeline service could be instantiated to increase throughput. Note that the processing pipeline could itself contain a CAS Multiplier component so that a single request to the service could be a reference to collection of artifacts to be processed.
+   </p>
+                                                <p>
+    Included with UIMA AS is a sample application, RunRemoteAsyncAE. This application demonstrates most of the features of the new UIMA asynchronous API, including the ability to use a UIMA Collection Reader to push documents to a specified service.
+   </p>
+                                                <p>
+     <table width="100%"><tr><td align="center" valign="middle">
+       <img src="./images/getting-started/runremoteasyncae.png" alt="RunRemoteAsyncAE application" border="0" />
+       <br>Figure 3 - Using RunRemoteAsyncAE to push documents into a UIMA AS service</br></td>
+     </tr></table>
+   </p>
+                            </blockquote>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                                                      <table border="0" cellspacing="0" cellpadding="2" width="100%">
+  
+ 
+      <tr><td bgcolor="#9289A2">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="UIMA AS - What next?"><strong>UIMA AS - What next?</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+    Go to the <a href="http://incubator.apache.org/uima/downloads.cgi">UIMA Download Page</a> and get the "UIMA AS Asynchronous Scaleout" package in zip or tar format. Unpack and use in place of the base UIMA framework. See the README file in the top level directory for instructions on deploying and testing standard UIMA example annotators as UIMA AS services.
+   </p>
+                            </blockquote>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                            </blockquote>
+        </p>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+
+                                        </td>
+                </tr>
+
+                <!-- FOOTER -->
+                <tr><td colspan="2">
+                    <hr noshade="" size="1"/>
+                </td></tr>
+                <tr><td colspan="2">
+                    <div align="center"><font color="#525D76" size="-1"><em>
+                    Copyright &#169; 2006-2008, The Apache Software Foundation
+                    </em></font></div>
+                </td></tr>
+            </table>
+        </body>
+    </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

Modified: incubator/uima/site/trunk/uima-website/docs/documentation.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/documentation.html?rev=679553&r1=679552&r2=679553&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/documentation.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/documentation.html Thu Jul 24 14:38:51 2008
@@ -260,6 +260,11 @@
 	<li><a href="doc-uima-pears.html">Getting Started: Working With PEARs</a><br />
 		For UIMA users who want to know what a UIMA PEAR package is, how to generate them 
 		and how to use them within UIMA applications.</li>
+	<br />
+	<li><a href="doc-uimaas-what.html">Getting Started: UIMA Asynchronous Scaleout</a><br />
+		For UIMA users who need to scale out their UIMA analytics to achieve higher throughput, get
+                faster response time, and to develop applications utilizing UIMA Flow Controllers,
+                CAS Multipliers and advanced error handling capability.</li>
 	
 	</ul>
    </p>