Skip to content

Minor changes to some documentation and makefile #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ktu wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Minor changes to some documentation and makefile #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions csv2fst/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ FOMA=foma

# Source files
# Change this to match your source morphology directory
MORPHOLOGYSRCDIR=~/OjibweMorph
MORPHOLOGYSRCDIR=$(MORPHOLOGY_DIR)
VERB_JSON = $(MORPHOLOGYSRCDIR)/config/ojibwe_verbs.json
NOUN_JSON = $(MORPHOLOGYSRCDIR)/config/ojibwe_nouns.json
# Change this to match your Lexical database directory
DATABASEDIR=~/OPDDatabase
DATABASEDIR=$(LEXICAL_DIR)

# YAML tests
CREATEYAML=../csv2yaml/create_yaml.py
Expand Down
19 changes: 11 additions & 8 deletions csv2fst/docs/howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,14 @@ $ cd ..

`make` will print a lot of information about the compilation process. You may want to keep track of how many skipped OPD entries there are for nouns, verbs and all other word classes. The number of skipped entries for nouns and verbs should be < 100 each (37 skipped lexemes for nouns and 56 for verbs when Miikka built on 2024/06/18). For other word classes, there should be no skipped entries.

Then you need to run `make` in ParserTools, which builds the FST in the directors ParserTools/csv2fst/generated. Remember to also install python library requirements. Before you run make, you will need to edit two Makefile variables:
Next, you will need to export two environment variables:

* `MORPHOLOGYSRCDIR` which should point to your OjibweMorph clone.
* `DATABASEDIR` which should point to your OPDDatabase clone
```
$ export MORPHOLOGY_DIR=/path/to/OjibweMorph
$ export LEXICAL_DIR=/path/to/OPDDatabase
```

Then you need to run `make` in ParserTools, which builds the FST in the directors ParserTools/csv2fst/generated. Remember to also install python library requirements.

```
$ cd ParserTools/csv2fst
Expand Down Expand Up @@ -90,22 +94,21 @@ The first two log files should show very few failures (5-15 fails per file). The

## The `ParserTools/csv2fst/csv2lexc.py` script

How to compile lexc-files (for nouns and verbs) using `csv2lexc.py`:
To compile lexc-files (for nouns and verbs) using `csv2lexc.py`, OjibweMorph and OPDDatabase (or a different set of morphological paradigms and another lexical database) are required for compilation. You may have already used these repositories in previous steps.

```
# OjibweMorph and OPDDatabase (or a different set of morphological paradigms and another lexical database)
# are required for compilation
$ export MORPHOLOGY_DIR=/path/to/OjibweMorph
$ export LEXICAL_DIR=/path/to/OPDDatabase

$ python3 csv2lexc.py --config-files $MORPHOLOGY_DIR/config/ojibwe_nouns.json,$MORPHOLOGY_DIR/config/ojibwe_verbs.json \
--source-path $MORPHOLOGY_DIR \
--database-path $LEXICAL_DIR \
--lexc-path generated_lexc_code \
--read-lexical-database True
--read-lexical-database True \
--add-derivations True
```

Depending on how you've defined the configuration files, the command might generate the following files in the directory `generated_lexc_code`:
Depending on how you've defined the target `lexc-path` directory in configuration files, the command might generate the following files in the directory `generated_lexc_code`. Note that the `lexc-path` must exist in order to write to it.

```
ojibwe_irregular_verbs.lexc # Irregular verbs
Expand Down