Thanks Marshall for you feedback. I integrated most of them and
published the articles.
http://incubator.apache.org/uima/documentation.html
Does anyone else has a topic for the getting started series?
Maybe one of the next can be "Writing my first simple UIMA annotator".
-- Michael
Marshall Schor wrote:
Hi Michael -
Just took a look. I like the idea of a quick-start.
It seems there are two themes in this article - maybe they would be
better if separated. One is more a "why UIMA" story,
and the other is how to install and get started.
My sense is that people prefer shorter, targeted pages, and would find
this more consumable if split up.
Some more specific comments:
What Can UIMA Be Used For:
---------------------------------
I think this topic confuses applications that can be built ** if you
have the proper annotator components **.
When written this way, it leads users to have the expectation that the
analysis capability comes with UIMA.
I think it is useful to say something like this:
UIMA is, by itself, an empty framework. Its purpose is to enable a
world-wide, diverse community to develop
inter-operable, often complex analytic components, and allow them to be
combined and run together, with
framework supplied scaled-out and remoting as needed.
Then it would be good to link to community sites giving creedence to the
notion that UIMA is being widely
adopted for this purpose. (CMU repository, repository in Germany, link
to Gale project use of UIMA,
maybe do a google search for other good links).
Then, maybe some use cases.
INSTALL UIMA:
-------------------
suggest you give a link to how to verify the download (what are all
those .asc files - a user may be asking herself).
suggest you use some visual formatting to make it clear there are 4
steps:
download/unzip, set env vars (2 vars), <optional> augment PATH,
<optional> run script
Visual formatting can also be used in other sections, too :-) e.g.,
Running the UIMA Analysis Example.
That's all for now :-) -Marshall
Michael Baessler wrote:
Michael Baessler wrote:
I have written an UIMA Getting Started - UIMA Examples article and
posted it on the Apache UIMA website.
The article gives a short introduction about what UIMA is, what it
can be used for, how it is installed and how the
UIMA analysis example can be executed. I hope that it helps first
time users to get an impression about what UIMA is
and what they can do with.
My plan is to create a series of UIMA Getting Started articles about
different topics.
One of the next articles can be "Writing my first analysis
component". The articles should not replace the UIMA documentation,
they should just give a short overview with the basic concepts to
reduce the warm up time for UIMA.
Currently there is no link to the article available on the website,
since the UIMA analysis example that is used in the article will
only be released with the next Apache UIMA release.
But you can find the article here:
http://incubator.apache.org/uima/doc-uima-examples.html
Your comments and feedback are welcome?
-- Michael
Does anyone had the chance to look at the getting started document?
I would like to publish it with the UIMA 2.2 release.
-- Michael
