Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jrrobison1 committed Aug 18, 2024
1 parent 1ada07d commit 8c31d4a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Python library for computing propositional idea density.
## Introduction

pycpidr is a Python library which determines the propositional idea density of an English text automatically. This project aims to make this functionality more accessible to Python developers and researchers. pycpidr provides two ways of computing idea density:
- CPIDR. The CPIDR implementation in pycpidr is a direct port of the Computerized Propositional Idea Density Rater (CPIDR) 3.2 (Brown et al 2008)[^1]
- DEPID. This library implements the DEPID algorithm described by Sirts et al (2017)[^2]
- CPIDR. The CPIDR implementation in pycpidr is a direct port of the Computerized Propositional Idea Density Rater (CPIDR) 3.2 (Brown et al., 2008)[^1]
- DEPID. This library implements the DEPID algorithm described by (Sirts et al., 2017)[^2]

Here's a quick example of how to use pycpidr:
```python
Expand Down Expand Up @@ -105,7 +105,7 @@ for dep in dependencies:
```

#### Using custom filters
pycpidr DEPID mode supports custom filtering of sentences and tokens. By default, pycpidr uses filters described by Sirts et al (2017):
pycpidr DEPID mode supports custom filtering of sentences and tokens. By default, pycpidr uses filters described by (Sirts et al., 2017):
- Sentence filter.
- Filter out sentences with "I" or "You" as the subject of the sentence (i.e. if the "I" or "You" token dependency is "nsubj" and it's head dependency is the root).
- Note: Sirts et al (2017) also filters out vague sentences using SpeciTeller. That is a filter which pycpidr does not yet implement.
Expand Down

0 comments on commit 8c31d4a

Please sign in to comment.