JAVA(tm) NEURAL NETWORK TOOLKIT             Wilfred Gander - Lorenzo Patocchi
----------------------------------------------------------------------------





                                JAVA(tm) NEURAL
                               NETWORK TOOLKIT



									jaNet





                                 

                             Project supervisor

                              Dr. Werner Hett
                               hew@isbiel.ch


                                   Authors

                      Wilfred Gander Lorenzo Patocchi


                              Current version

                           1.0 beta 1 Release Here





----------------------------------------------------------------------------

JAVA(tm) NEURAL NETWORK TOOLKIT             Wilfred Gander - Lorenzo Patocchi
----------------------------------------------------------------------------

  VERSION: 1.0 beta 1

  PROJECT jaNet

          jaNet beta version is the result of a diplom work at
          Biel School of Engineering by a two persons team. During
          four weeks we made the design and implementation of
          jaNet package plus a base module, the backpropagation
          neural network type. jaNet will stay in beta version
          until all bugs and problems will be reduced to almost
          zero, this mean the same release time of Sun JDK 1.1
          plus a short period of tests.

  DESCRIPTION

          jaNet package is a java neural network toolkit. With
          jaNet you can design, test, train, optimize an ideal
          neural network for your private application and when the
          network is ready and cooked, you can save it in a file.
          You can then include such network in your private
          application using jaNet.backprop package.

  DOWNLOADING

  
    You can download all sources from jaNet web home page:
	
		http://www.isbiel.ch/Projects/janet/index.html
		
	the following packages:
		
          jaNet with documentation:

               jaNet-1.0beta1.tar.Z (1479 Kb)
               jaNet-1.0beta1.tar.gz (1018 Kb)
               jaNet-1.0beta1.zip (1047 Kb)

          jaNet without documentation:

               jaNet.nodoc-1.0beta1.tar.Z (114 Kb)
               jaNet.nodoc-1.0beta1.tar.gz (78 Kb)
               jaNet.nodoc-1.0beta1.zip (107 Kb)

  UNCOMPRESSING

          Is important when uncompressing files to keep the
          directory structure as in compressed file, since jaNet
          needs this structure for his functionality. The final
          class tree looks like:

          :
          +-- jaNet/
          |     |
          |     +--- backprop/
          |     |       |
          :     -       +---- gui/


          Uncompressing under UNIX:


            zcat jaNet-1.0beta1.tar.gz | tar xvf -
            zcat jaNet-1.0beta1.tar.Z  | tar xvf -


          Don't use pkunzip when uncompressing under Windows,
          since it doesn't restore characters with correct upper
          and lower case. It's better to use Winzip or Wincmd
          (long filenames).

  DOCUMENTATION

          All documentation is written in french, probably it will
          be translated in english, but not before the end of
          year. We are sorry for this inconvenience. Exaustive and
          intuitive demo applications is also provided with jaNet
          pack.

          The documentation is a 54 pages PostScript file (A4
          size).
          The original PS file had problems with ghostview. There
          is a new version (05.10.96) of the document distrib.ps.
          You can download it here (distrib.zip) (931 Kb).

          API reference of all classes of jaNet and other packages
          can be found here:

               jaNet API reference

  EXAMPLES

          Here are few very simple demo programs that shows you
          how to use jaNet.backprop package. You'll see, it is
          very simple.

             * myTC.java How to integrate a jaNet module in your
               application.
             * myTCtrainer.java How to use jaNet.backprop package
               more completely.

          You also find them in jaNet 1.0 beta 1 release with
          makefiles and project files.

  REQUIREMENTS

    In order to run this application you need to install (if
    you didn't yet) a java interpreter, which may be SUN's
    JDK, Symantec Cafe, Microsoft visual J++ or others.
    Since this is an application and not an applet it can
    not run on a web browser nor remote from a server.

  RUNNING SCRIPT & BATCH:
  
    You may not want to type all the long command line for this application,
    so we build a very simple script for UNIX and a batch for Windows
    to run it simply, correctly and from anywhere.
    You will need to edit this script/batch and change the location where
    you installed jaNet classes in JANETHOME variable.
    
    FILES:
    
      janet.csh	for UNIX
      janet.bat for Windows


  SOURCE AVAILABILITY

    jaNet sources are now available under GNU General Public Licence. 
    We advice to anyone who wants them to carefully read all terms in 
    the GPL before downloading.

  LICENSE
    
    Whole jaNet sources and compiled classes are distributed under 
    GNU General Public Licence, please read carefully all terms in 
    the GPL before downloading or redistributing. File LICENSE contain
    all current terms of GNU GPL.

  COMMANDLINE OPTIONS:
  
    If you want jaNet to run correctly you must provide path and
    name of configuration file and jaNet home. If those parameters 
    are not specified the defauld values will be used:
    
    	config path 		. (current directory)
    	config file			jaNet.cfg
    	jaNet home			. (current directory)
    	
    To modify those settings use the commandline options:
    	
    	-cfgpath <path>		to change config file location path
    	-cfgfile <filename> to modify jaNet.cfg filename
    	-homepath <path>	to set jaNet home location path
    
  
  FILE EXTENSIONS:
  
    Common file extension for a jaNet project is ".prj" or in future
    it may change to ".jpj", common file extension for a BPN module 
    is ".bpn" and common file extension for pattern data is ".pat".
  	
  KNOWN BUGS

    Unfortunately not all features of jaNet have been implemented.
    Here a list of principal bugs:

             * extension filter in java API file dialogs doesn't
               work. No workarounds.

             * under Windows NT, files choosed with java API file
               dialogs appears with an extra ".*.*" at the end of
               original file name, throwing an illegal file name
               exception.
               Workaround: create by hand a void file and when
               saving with java API file dialog double click on
               it, it will ask to confirm overwrite, answer "Yes".

             * under Windows NT selecting a layer in
               backpropagation module may cause a GPF.
               Workaround: Click outside the layers to give focus
               on canvas, position mouse pointer over a layer
               without clicking ad read help keys on footer of BPN
               window.

     If you find any bug, please let us know !

   FUTURE FEATURES

     jaNet beta version permits only to add modules on
     projects, deattach them, control the save or the close
     of a module. In the next release, it will be possible to
     setup data channels and behaviour channels between the
     modules. So projects will not only group a few neural
     network modules but will provide an interaction between
     them. Tests and feasibility to use neural networks base
     packages (like jaNet.backprop) on the network will be
     made.

----------------------------------------------------------------------------
 1996 ISBiel by W.Gander & L.Patocchi 
----------------------------------------------------------------------------

    L. Patocchi & W.Gander (patol@info.isbiel.ch, gandw@info.isbiel.ch)
    
                 Biel School of Engineering - Switzerland

----------------------------------------------------------------------------
