Skip to content

Commit

Permalink
Merge pull request #1 from chriswales95/feature/remove-old-canary
Browse files Browse the repository at this point in the history
Merge branch Feature/remove old canary
  • Loading branch information
chriswales95 authored Jan 17, 2021
2 parents 3bc803f + d0c12eb commit 9930da8
Show file tree
Hide file tree
Showing 829 changed files with 4 additions and 17,202 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# Development files
*.swp
.DS_Store
/.idea
/.vscode
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

2 changes: 0 additions & 2 deletions MANIFEST.in

This file was deleted.

34 changes: 1 addition & 33 deletions README.md
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
1 change: 0 additions & 1 deletion _config.yml

This file was deleted.

Loading

0 comments on commit 9930da8

Please sign in to comment.