-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from chriswales95/feature/remove-old-canary
Merge branch Feature/remove old canary
- Loading branch information
Showing
829 changed files
with
4 additions
and
17,202 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,5 @@ | ||
# Development files | ||
*.swp | ||
.DS_Store | ||
/.idea | ||
/.vscode |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1 @@ | ||
## Canary | ||
|
||
**Canary should be considered pre-alpha softeware at present. It's an indicator of the direction we're heading in.** | ||
|
||
Canary is a Python library for Argument Mining. Argument Mining is the automated identifcation and extraction of argumentative data from natural language sources such as text files. | ||
|
||
The initial aim is to provide a novel implementation of an Argument Mining tool that someone is able to run on their own data set in order to find patterns or to extract argumentative structure from their data. | ||
|
||
### Getting Started | ||
|
||
To download and gain access to Canary run: | ||
|
||
Eventually there will be a pip capable install along the following lines: | ||
```python | ||
pip install Canary-am | ||
``` | ||
|
||
but for the moment we'll build and use Canary from source until we have a sufficiently robust and feature rich release candidate. | ||
|
||
### Example | ||
|
||
Basic example showing the extraction of Argumentative Components from a local file: | ||
|
||
```Python | ||
from canary import local | ||
|
||
components = canary.Local(file) | ||
|
||
print(components[1]) | ||
|
||
# Output | ||
['hence it is always said that competition makes the society more effective.', 'therefore without the cooperation, there would be no victory of competition.'] | ||
``` | ||
# Canary |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.