Skip to content

Commit

Permalink
update in docs by cp since gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
flammie committed Jun 8, 2022
1 parent b921c9b commit bda2533
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 30 deletions.
28 changes: 28 additions & 0 deletions docs/NEWS.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,34 @@
This file lists noteworthy changes between releases, for full list of changes,
see git log and then `ChangeLog.old`.

## Significant changes in 0.9.9

* slight updates to convenience bash scripts
* Unimorph 4 compatible
* added the name database from Finnish governments open data repository:
approx. 20,000 new names and 20,000 existing names verified
* Changed to semver and not so bi-yearly schedule, and to main branch instead
of outdated git flow model
* nearly 10,000 words moved from main lexicon to MWE; added MWE fragments that
were previously not in main lexicon (e.g. "Records", "Air", "Las", "Agia",
"Group", "Air", ...)
* few thousands of words from fiwkikt, enwikt and joukahainen including new
paradigms for cool and chic (i.e. loan consonant final adjectives), galanga
root, cisgender, genetic scissors, gay drumming, hybrid influencing,
spike protein and a lot of birds, mice and compounds
* preliminary support for conda
* homonyms dropped cross part-of-speech, only lemmas within same pos get
homonym code and analysis now
* Removed multi-words from main lexicon, if a lexeme has space in it all parts
are analysed separately
* canonic sort order for TSV files based on python sort (since bash sort is
not portable across OSes or stable)
* minor fixes for c++ demo and api
* updated words from wiktionaries, joukahainen...
* basic NER parser (~90 % of finer covered)
* improvements in documentation based on feedback
* big thanks to **Patreons** and **GitHub sponsors** for continued support

## Significant changes in 20200511

* Universal dependencies version 2.6 compatible
Expand Down
76 changes: 54 additions & 22 deletions docs/README.markdown
Original file line number Diff line number Diff line change
@@ -1,35 +1,41 @@
# Omorfi–Open morphology of Finnish
# 🇫🇮Omorfi–Open morphology of Finnish

This is a free/libre open source morphology of Finnish: a database, tools and
APIs. Everything you need to build NLP applications processing Finnish language
words and texts.

* 🇫🇮 high-quality Finnish text analysis and generation
* 🩸 bleeding edge
* ⚡ blazing fast

[![Build Status](https://travis-ci.org/flammie/omorfi.svg?branch=develop)](https://travis-ci.org/flammie/omorfi)
(stable master branch:
[![Build Status](https://travis-ci.org/flammie/omorfi.svg?branch=master)](https://travis-ci.org/flammie/omorfi)
)
![CI](https://github.com/flammie/omorfi/workflows/CI/badge.svg)

## Documentation

I try to keep this `README` very condensed for github.
For more detailed information, see [github pages for
omorfi](//flammie.github.io/omorfi/).

## Citing and academic works

Citation information can be found in file
[CITATION](https://github.com/flammie/omorfi/blob/develop/CITATION). For further
Citation information is available in github's *cite this repository* function,
backed by the
[CITATION.cff](https://github.com/flammie/omorfi/blob/CITATION.cff). For further
details, see [omorfi articles](//flammie.github.io/omorfi/articles.html).

## Downloading and further information

Omorfi packages can be downloaded from github:
Omorfi source packages can be downloaded from github:

* [omorfi releases](https://github.com/flammie/omorfi/releases)

or the most current version using git. For more information, see
[Release policy](https://flammie.github.io/omorfi/releases.html)

For quick installation under restricted environments, see Python or Docker
instructions below.

## Dependencies

* **hfst-3.15** or greater,
Expand All @@ -45,17 +51,28 @@ Optionally:
* *hfst-ospell-0.2.0* or greater needed for spell-checking
* *Java 7*, or greater, for Java bindings

For further information, see [Installation
instructions](//flammie.github.io/omorfi/install.html)

## Installation

It is possible to download the language models from previous release from the
internet (Minimal installation) or compile them from the database (Normal
installation), the former is recommended for new users and latter for advanced
users.
For detailed instructions and explanations of different options, see
[Installation instructions](//flammie.github.io/omorfi/install.html) on the
github pages site. This readme is a quick reference.

### Full installation

Requires *all* dependencies to be installed.

```
autoreconf -i
./configure
make
make install
```

Will install binaries and scripts for all users on typical environments

### Minimal installation
### Minimal "installation"

To skip language model building and use some of the scripts locally.

```
autoreconf -i
Expand All @@ -66,16 +83,31 @@ src/bash/omorfi-download.bash
This will download some of the pre-compiled dictionaries into your current
working directory.

### Normal installation
### Python installation

It is possible to install within python via `pip` or `anaconda`. The
dependencies that are not available in pip or anaconda will not be usable, e.g.
syntactic analysis and disambiguation using VISL CG 3.

```
./configure
make
make install
pip install omorfi
```

For further instructions, see [Intallation
instructions](//flammie.github.io/omorfi/install.html).
![Anaconda](https://anaconda.org/flammie/omorfi/badges/installer/conda.svg)

```
conda install -c flammie omorfi
```

### Docker

It is possible to use omorfi with a ready-made docker container, there is a
Dockerfile in `src/docker/Dockerfile` for that.

```
docker build -t omorfi Dockerfile
docker run -it omorfi bash
```

## Usage

Expand Down Expand Up @@ -145,7 +177,7 @@ participate, read further information in
* Issues and problems may be filed in [our github issue
tracker](https://github.com/flammie/omorfi/issues), including support
questions
* [IRC channel #omorfi on Freenode](irc://Freenode/#omorfi) is particularly good
* [IRC channel #omorfi on OFTC](irc://OFTC/#omorfi) is particularly good
for live chat for support questions, suggestions and discussions
* [omorfi-devel mailing
list](https://groups.google.com/forum/#!forum/omorfi-devel) is good for longer
Expand Down
39 changes: 31 additions & 8 deletions docs/THANKS.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,12 @@ contributed by reporting problems, suggesting various improvements or
submitting actual code. Here is a list of these people. Help me keep it
complete and exempt of errors.

In order of additions:
The bigger groups whose contributions directly or indirectly have helped omorfi
(power users and providers of lexical data):

- The lexical data was greatly extended both horizontally and vertically
by Inari Listenmaa in a B.A. thesis project.
- Helsinki Univ. staff and students, esp:
- Kimmo Koskenniemi
- Krister Lindén
- Erik Axelson
- Miikka Silfverberg
- Anssi Yli-Jyrä
- Inari Listenmaa
- Sjur Moshagen
- The courses clt260, clt270 and fullskaliga morfologiska lexikon students and
staff for extensive testing.
- University of Turku bio-NLP group (a lot of resources have been exchanged
Expand All @@ -29,4 +23,33 @@ In order of additions:
- fi.wiktionary.org contributors
- Universal Dependencies (Finnish) contributors
- Unimorph contributors
- finer contributors
- finnwordnet contributors

People with specific comments, bug reports and pull requests (alphabetically):

- Anssi Yli-Jyrä
- Erik Axelson
- Frankie Robertson
- Fred Karlsson
- Inari Listenmaa
- Joonatan Saarhelo
- Juha Kuokkala
- Kimmo Koskenniemi
- Krister Lindén
- Leo Leppänen
- Miikka Silfverberg
- Mika Hämäläinen
- Sam Hardwick
- Sjur Moshagen

See also: [github
contributors](https://github.com/flammie/omorfi/graphs/contributors)

## Patreons, Github sponsors and other supporters

(alphabetically)

* Ju

and a number of donations from sources wishing to stay anonymous.

0 comments on commit bda2533

Please sign in to comment.