Skip to content
Snippets Groups Projects
Commit 8d0fd6c9 authored by Mateusz Klimaszewski's avatar Mateusz Klimaszewski
Browse files

Add configuration files to packaged library and pip installation

instructions.
parent 77ef5890
Branches
Tags
2 merge requests!20Release 1.0.0b2.,!19Release 1.0.0b2.
Pipeline #2250 passed with stage
in 6 minutes and 43 seconds
clean:
rm -rf COMBO.egg-info
rm -rf combo.egg-info
rm -rf .eggs
rm -rf .pytest_cache
......
......@@ -12,9 +12,8 @@
## Quick start
Clone this repository and install COMBO (we suggest creating a virtualenv/conda environment with Python 3.6+, as a bundle of required packages will be installed):
```bash
git clone https://gitlab.clarin-pl.eu/syntactic-tools/clarinbiz/combo.git
cd combo
python setup.py develop
pip install -U pip setuptools wheel
pip install --index-url https://pypi.clarin-pl.eu/simple combo
```
Run the following commands in your Python console to make predictions with a pre-trained model:
```python
......
File moved
File moved
import copy
import logging
import pathlib
from typing import Union, List, Dict, Iterable, Optional, Any, Tuple
import conllu
......@@ -79,7 +80,9 @@ class UniversalDependenciesDatasetReader(allen_data.DatasetReader):
file_path = [file_path] if len(file_path.split(",")) == 0 else file_path.split(",")
for conllu_file in file_path:
with open(conllu_file, "r") as file:
file = pathlib.Path(conllu_file)
assert conllu_file and file.exists(), f"File with path '{conllu_file}' does not exists!"
with file.open("r"):
for annotation in conllu.parse_incr(file, fields=self.fields, field_parsers=self.field_parsers):
yield self.text_to_instance(annotation)
......
"""Main entry point."""
import logging
import os
import pathlib
import tempfile
from typing import Dict
......@@ -31,7 +32,7 @@ flags.DEFINE_string(name="output_file", default="output.log",
help="Predictions result file.")
# Training flags
flags.DEFINE_list(name="training_data_path", default="./tests/fixtures/example.conllu",
flags.DEFINE_list(name="training_data_path", default=[],
help="Training data path(s)")
flags.DEFINE_alias(name="training_data", original_name="training_data_path")
flags.DEFINE_list(name="validation_data_path", default="",
......@@ -62,7 +63,7 @@ flags.DEFINE_list(name="finetuning_training_data_path", default="",
help="Training data path(s)")
flags.DEFINE_list(name="finetuning_validation_data_path", default="",
help="Validation data path(s)")
flags.DEFINE_string(name="config_path", default="config.template.jsonnet",
flags.DEFINE_string(name="config_path", default=str(pathlib.Path(__file__).parent / "config.template.jsonnet"),
help="Config file path.")
# Test after training flags
......
# Installation
Clone this repository and install COMBO (we suggest using virtualenv/conda with Python 3.6+):
```bash
git clone https://gitlab.clarin-pl.eu/syntactic-tools/clarinbiz/combo.git
cd combo
python setup.py develop
pip install -U pip setuptools wheel
pip install --index-url https://pypi.clarin-pl.eu/simple combo
combo --helpfull
```
......@@ -11,8 +10,8 @@ combo --helpfull
```bash
python -m venv venv
source venv/bin/activate
pip install --upgrade pip
python setup.py develop
pip install -U pip setuptools wheel
pip install --index-url https://pypi.clarin-pl.eu/simple combo
```
## Problems & solutions
......
......@@ -19,7 +19,7 @@ REQUIREMENTS = [
]
setup(
name='COMBO',
name='combo',
version='1.0.0b1',
author='Mateusz Klimaszewski',
author_email='M.Klimaszewski@ii.pw.edu.pl',
......@@ -31,6 +31,7 @@ setup(
setup_requires=['pytest-runner', 'pytest-pylint'],
tests_require=['pytest', 'pylint'],
python_requires='>=3.6',
package_data={'combo': ['config.graph.template.jsonnet', 'config.template.jsonnet']},
entry_points={'console_scripts': ['combo = combo.main:main']},
classifiers=[
'Development Status :: 4 - Beta',
......
......@@ -41,7 +41,7 @@ class TrainingEndToEndTest(unittest.TestCase):
"word_batch_size": "1",
"use_tensorboard": "False"
}
params = Params.from_file(os.path.join(self.PROJECT_ROOT, "config.template.jsonnet"),
params = Params.from_file(os.path.join(self.MODULE_ROOT, "config.template.jsonnet"),
ext_vars=ext_vars)
# when
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment