Skip to content
This repository was archived by the owner on Jul 7, 2021. It is now read-only.

Commit 539c7f4

Browse files
author
Ferit Tunçer
committed
2 parents 21a758c + 5391479 commit 539c7f4

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
# ITU Turkish NLP Pipeline Caller
1+
# ITU Turkish NLP Pipeline Caller [![Build Status](https://travis-ci.org/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller.svg?branch=master)](https://travis-ci.org/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller) [![Join the chat at https://gitter.im/freecodecamp/freecodecamp](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller)
22
A Python3 wrapper tool to use [ITU Turkish NLP Pipeline API](http://tools.nlp.itu.edu.tr/)
3-
4-
[![Build Status](https://travis-ci.org/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller.svg?branch=master)](https://travis-ci.org/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller) [![Join the chat at https://gitter.im/freecodecamp/freecodecamp](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller)
3+
54

65
For details of the pipeline, please check the pipeline page and the sources below.
76

@@ -16,27 +15,27 @@ of Turkish. Computational Linguistics, 34 no.3, 2008. ](http://www.mitpressjourn
1615
## Usage
1716
To be able to use the pipeline, you need an **authentication token** (details on API web page).
1817
### Setup
19-
Simply run `python3 ./setup.py install` to install
18+
Simply run `python3 ./setup.py install` to install.
2019
### As a Command Line Tool
2120
The tool reads the token from `pipeline.token` file (under the same directory with the tool) by default.
2221

2322
Simply
24-
`python3 ./pipeline.caller.py filename`
23+
`pipeline.caller.py >filename>`
2524
reads input file <filename>, prints the output under `./output/output<system_time>`
2625

2726
You can select the pipeline tool by using `-t` option
28-
`python3 ./pipeline.caller.py filename -t <tool_name>`
27+
`pipeline.caller.py <filename> -t <tool_name>`
2928
default is "pipelineNoisy"
3029

3130
You can force the encoding for I/O by using `-e` option
32-
`python3 ./pipeline.caller.py filename -e <encoding>`
31+
`pipeline.caller.py <filename> -e <encoding>`
3332
default is your system locale
3433

3534
And you can change the output directory by using `-o` option
36-
`python3 ./pipeline.caller.py filename -o another_directory`
37-
default is "pipeline_caller_output"
35+
`pipeline.caller.py <filename> -o <another_directory>`
36+
default is "output"
3837

39-
Also `python3 ./pipeline.caller.py --help` shows the help menu.
38+
Also `pipeline.caller.py --help` shows the help menu.
4039
### Using As a Module
4140

4241
`import pipeline_caller`
@@ -64,7 +63,7 @@ Check DEFAULTS block in the source code if you need (generally, you don't) to ch
6463
Special thanks to [Asst. Prof. Dr. Peter Schüller](https://github.com/peschue) for his great suggestions!
6564

6665
## Author, Copyright & License
67-
This work is a part of a [KnowLP](knowlp.com) research project.
66+
This work is a part of a [KnowLP](http://www.knowlp.com) research project.
6867

6968
Copyright 2015 Ferit Tunçer, <[email protected]>
7069

0 commit comments

Comments
 (0)