Revision: 14877
http://gate.svn.sourceforge.net/gate/?rev=14877&view=rev
Author: valyt
Date: 2012-01-04 17:11:34 +0000 (Wed, 04 Jan 2012)
Log Message:
-----------
Some more documentation in preparation for the new version release.
Modified Paths:
--------------
mimir/trunk/doc/admin.tex
mimir/trunk/doc/changes.tex
mimir/trunk/doc/extending.tex
mimir/trunk/doc/mimir-guide.tex
mimir/trunk/doc/searching.tex
Added Paths:
-----------
mimir/trunk/doc/img/index-config-scorer.png
mimir/trunk/doc/quickstart.tex
Modified: mimir/trunk/doc/admin.tex
===================================================================
--- mimir/trunk/doc/admin.tex 2012-01-04 10:54:28 UTC (rev 14876)
+++ mimir/trunk/doc/admin.tex 2012-01-04 17:11:34 UTC (rev 14877)
@@ -41,6 +41,13 @@
instead generated by the build process. See Section~\ref{sec:building} for
details on how to do that. Once created, it is ready to use as-is or as a base
for customisation to add security, look and feel customisation, etc.
+
+\item[mimir-cloud] A fully fledged Grails application, that uses the mimir-web
+plugin and also includes security support. This is the exact implementation
used
+for \Mimir{} servers supplied on the GATECloud.net
+platform\footnote{\url{https://gatecloud.net}: a platform for running
GATE-based
+processes on the cloud.}. This application should be suitable without any
+modifications for most users.
\end{description}
\section{Building and Running the mimir-demo Web
Modified: mimir/trunk/doc/changes.tex
===================================================================
--- mimir/trunk/doc/changes.tex 2012-01-04 10:54:28 UTC (rev 14876)
+++ mimir/trunk/doc/changes.tex 2012-01-04 17:11:34 UTC (rev 14877)
@@ -9,9 +9,11 @@
points identified.
\item Simplified all the query APIs by making them almost completely
synchronous.
- \item Added support for ranking the results.
- \item Brand new implementations for all the query runners.
- \item Replaced the old GWT based UI with a completely new implementation (see
+ \item Added support for ranking the results (see
+ Sections~\ref{sec:search:rank} and \ref{sec:extend:scorers}).
+ \item New implementations for all the query runners (used when searching
+ local, remote and federated indexes).
+ \item Replaced the old GWT based UI with a new implementation (see
Section~\ref{sec:search:gus}.
\item Added the mimir-cloud web application to the source tree, see
Section~\ref{sec:mimir-cloud}.
Modified: mimir/trunk/doc/extending.tex
===================================================================
--- mimir/trunk/doc/extending.tex 2012-01-04 10:54:28 UTC (rev 14876)
+++ mimir/trunk/doc/extending.tex 2012-01-04 17:11:34 UTC (rev 14877)
@@ -188,6 +188,7 @@
the helpers are called in sequence.
\subsection{Packaging New Helper Types for Use with \Mimir}
+\label{sec:extend-package-plugins}
To create a new helper type and make it available to \Mimir\ you need to first
write your Java class that implements {\tt SemanticAnnotationHelper}, typically
@@ -206,9 +207,47 @@
This directory is now a CREOLE plugin that can be loaded into \Mimir, for
example by using the configuration options described in
Section~\ref{sec:admin:config}.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Registering new Scorers}
+\label{sec:extend:scorers}
+The set of scoring algorithms made available in the admin interface is
specified
+in the application configuration file (described in
+Section~\ref{sec:admin:config}). The default configuration includes the
+following options:
+\begin{lstlisting}[language=Java]
+scorers.'Count Scoring' = {
+ new DelegatingScoringQueryExecutor(new CountScorer())
+}
+scorers.'TF.IDF' = {
+ new DelegatingScoringQueryExecutor(new TfIdfScorer())
+}
+scorers.'BM25' = {
+ new DelegatingScoringQueryExecutor(new BM25Scorer())
+}
+scorers.'Hit Length Scoring' = {
+ new BindingScorer()
+}
+\end{lstlisting}
+
+Each declaration maps a Groovy closure to the name of a scorer. The closure
must
+return an object implementing the
+\lstinline!gate.mimir.search.score.MimirScorer! interface, which itself extends
+the MG4J interface \lstinline!it.unimi.dsi.mg4j.search.score.DelegatingScorer!.
+
+\Mimir{} provides the
+\lstinline!gate.mimir.search.score.DelegatingScoringQueryExecutor! class which
+can be used to wrap one of the scorer implementations provided by MG4J. If none
+of those are suitable, you can write your own custom implementations and make
+them avaialble to \Mimir{} in the form of a GATE CREOLE plugin. This will
ensure
+the new classes are added to the classpath and can be found by the system. See
+Section~\ref{sec:extend-package-plugins} for a description of how to declare
new
+plugins, and Section~\ref{sec:admin:config} for information about loading
+additional plugins.
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section{Embedding \Mimir\ in a Custom Grails application}
+
+\section{Embedding \Mimir\ in a Custom Grails Application}
\label{sec:extend:customapp}
The demo Grails application provided with \Mimir\ provides access to the
Added: mimir/trunk/doc/img/index-config-scorer.png
===================================================================
(Binary files differ)
Property changes on: mimir/trunk/doc/img/index-config-scorer.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: mimir/trunk/doc/mimir-guide.tex
===================================================================
--- mimir/trunk/doc/mimir-guide.tex 2012-01-04 10:54:28 UTC (rev 14876)
+++ mimir/trunk/doc/mimir-guide.tex 2012-01-04 17:11:34 UTC (rev 14877)
@@ -44,6 +44,9 @@
%\input{changes}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\chapter{Quick Start}\label{sec:quickstart}
+\input{quickstart}
+
\chapter{Installing and Managing \Mimir}\label{sec:admin}
\input{admin}
\chapter{Indexing Documents with \Mimir}\label{sec:indexing}
Added: mimir/trunk/doc/quickstart.tex
===================================================================
--- mimir/trunk/doc/quickstart.tex (rev 0)
+++ mimir/trunk/doc/quickstart.tex 2012-01-04 17:11:34 UTC (rev 14877)
@@ -0,0 +1,40 @@
+This chapter is aimed at the impatient reader who wants a working system as
+quickly as possible. The technical detail is deliberately kept at a minimum so,
+while you will hopefully end up with something that works, you will not
+necessarilly understand how it all fits together. For that, please read the
+remainder of this guide.
+
+We suggest you try this on a 64~bit operating system, as that is better suited
+for running \Mimir{}. A 32~bit system would also work, but the maximum sizes
for
+the indexes wold be limited.
+
+In order to build and run a \Mimir{} server you will need the following pieces
+of software installed on your system:
+\begin{description}
+ \item[Java Development Kit] If you don't have one, you can download one from
+
Oracle\footnote{\url{http://www.oracle.com/technetwork/java/javase/downloads/index.html}}.
+ Make sure you get the JDK and not the Java Runtime Environment (JRE), as that
+ would not be suitable. Once installed, make sure your \verb!JAVA_HOME!
+ environment variable points to the location where the JDK was installed.
+ \item[Apache ANT] version 1.8.1 or later. You can download it from
+ \url{http://ant.apache.org/}. Once installed, make sure your \verb!ANT_HOME!
+ environment variable points to the top-level directory of your installation.
+ \item[Grails] version 1.3.7. You can download this from
+ \url{http://grails.org}. Once installed, make sure your \verb!GRAILS_HOME!
+ environment variable points to the top-level directory of your installation.
+\end{description}
+
+After all these prerequisites are installed, we can move to building a \Mimir{}
+application. For the purposes of this demo, we will build the {\tt mimir-demo}
+application. In a real deployment you may find the alternative application
({\tt
+mimir-cloud}) more suitable.
+
+To build {\tt mimir-demo} follow these steps:
+\begin{enumerate}
+ \item download \Mimir{}
+ \item build the library
+ \item generate the demo application
+ \item build the demo application
+\end{enumerate}
+
+
Property changes on: mimir/trunk/doc/quickstart.tex
___________________________________________________________________
Added: svn:eol-style
+ native
Modified: mimir/trunk/doc/searching.tex
===================================================================
--- mimir/trunk/doc/searching.tex 2012-01-04 10:54:28 UTC (rev 14876)
+++ mimir/trunk/doc/searching.tex 2012-01-04 17:11:34 UTC (rev 14877)
@@ -828,5 +828,28 @@
{\tt getLength} (the number of tokens it covers).
\section{Ranking of Results}
+\label{sec:search:rank}
-Starting with version $4.0$, \Mimir{} support the ranking of results.
\ No newline at end of file
+Starting with version $4.0$, \Mimir{} supports the ranking of results. This
+means that a scoring algorithm is applied to assess the relevance of each
+returned document and that documents are returned in decreasing order of their
+scores. To support this, \Mimir{} will need to execute the query twice: once to
+calculate the scores, and a second time to collect the actual hits.
+Consequently, the query execution will be a bit slower when using ranking.
+
+\subsection{Configuring Ranking}
+
+Each searchable index can be configured to use a scorer. When initially
created,
+all indexes have scoring disabled. This can be changed from the admin
interface,
+by editing the index configuration, as shown in Figure~\ref{fig:config-scorer}.
+
+\begin{figure}
+\begin{center}
+\includegraphics[scale=0.4]{img/index-config-scorer}
+\caption{Configuring a Scorer}
+\label{fig:config-scorer}
+\end{center}
+\end{figure}
+
+If the provided scoring algorithms are not suitable for your needs, you can add
+new ones as discussed in Section~\ref{sec:extend:scorers}.
\ No newline at end of file
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Ridiculously easy VDI. With Citrix VDI-in-a-Box, you don't need a complex
infrastructure or vast IT resources to deliver seamless, secure access to
virtual desktops. With this all-in-one solution, easily deploy virtual
desktops for less than the cost of PCs and save 60% on VDI infrastructure
costs. Try it free! http://p.sf.net/sfu/Citrix-VDIinabox
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
