Skip to content

Commit

Permalink
touch up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@interrogator
interrogator committed Aug 24, 2019
1 parent 0044f81 commit 9a826c9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions docs/building.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,18 +115,18 @@ Once parsed, the first sentence of the underlying dataset will modelled as somet

| File | Sent | Token | Word | Lemma | Wordclass | Part of speech | Governor index | Dependency role | Extra | dialog | doc_type | ent_id | ent_iob | being | funny | move | play_on | punchline | rating | sent_id | sent_len | some_schema | Speaker |
|------|----|----|---------|---------|-------------|------------------|------------------|-------------------|-----|----------|------------|----------|-----------|------------|---------|--------|-----------|-------------|----------|-----------|------------|---------------|-----------|
| text | 1 | 1 | A | a | DET | DT | 2 | det | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| text | 1 | 2 | lion | lion | NOUN | NN | 6 | nsubj | _ | False | joke | 0 | O | animal | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| text | 1 | 3 | and | and | CCONJ | CC | 2 | cc | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| text | 1 | 4 | a | a | DET | DT | 5 | det | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| text | 1 | 5 | cheetah | cheetah | NOUN | NN | 2 | conj | _ | False | joke | 0 | O | animal | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| text | 1 | 6 | decide | decide | VERB | VBP | 0 | ROOT | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| text | 1 | 7 | to | to | PART | TO | 8 | aux | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| text | 1 | 8 | race | race | VERB | VB | 6 | xcomp | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| text | 1 | 9 | . | . | PUNCT | . | 6 | punct | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 1 | A | a | DET | DT | 2 | det | _ | False | joke | 0 | O | animal | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 2 | lion | lion | NOUN | NN | 6 | nsubj | _ | False | joke | 0 | O | animal | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 3 | and | and | CCONJ | CC | 2 | cc | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 4 | a | a | DET | DT | 5 | det | _ | False | joke | 0 | O | animal | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 5 | cheetah | cheetah | NOUN | NN | 2 | conj | _ | False | joke | 0 | O | animal | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 6 | decide | decide | VERB | VBP | 0 | ROOT | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 7 | to | to | PART | TO | 8 | aux | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 8 | race | race | VERB | VB | 6 | xcomp | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |
| 001-joke-lion-pun | 1 | 9 | . | . | PUNCT | . | 6 | punct | _ | False | joke | 0 | O | | _ | setup | _ | False | 6.5 | 1 | 9 | 9 | NARRATOR |

## Next steps

Once you have a corpus, be it one or many files, annotated or unannotated, you are ready to feed it to *buzzword*. Simply drag and drop or click to upload your files, give your corpus a name, select a language, and hit `Upload and parse`.

Once the parsing is finished, a link to the new corpus will appear. Click it to explore the corpus in the `Explore` page. Click [here](/guide) for instructions on how to use the *Explore* page.
Once the parsing is finished, a link to the new corpus will appear. Click it to explore the corpus in the `Explore` page. Click [here](guide.md) for instructions on how to use the *Explore* page.
4 changes: 2 additions & 2 deletions docs/guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The dataset tab is also the place where you search the corpus. In *buzzword*, be

**Feature to search**: in the leftmost dropdown field, you select the feature you want to search (word form, lemma form, POS, etc). Each of these options targets a token or metadata feature, except *Dependencies*, which is used to search the dependency grammar with which a corpus has been parsed. To start out, select something simple, like 'Word', so that your search string will be compared to the word as it was writtin in the original, unparsed text.

**Query entry**: in the text entry field, you neeed to provide a case-sensitive regular expression that you want to match. The only exception to this is if you are searching *Dependencies*, in which case you will need to use [the depgrep query language](https://github.com/interrogator/depgrep). If you're new to regular expressions, and just want to find words that exactly match a string, enter `^word$`. The caret (`^`) denotes 'start of string', and the dollar sign (`$`) denotes the end of string. Without the dollar sign, the query would match not only *word*, but *wordy*, *wording*, *word-salad*, and so on.
**Query entry**: in the text entry field, you neeed to provide a case-sensitive regular expression that you want to match. The only exception to this is if you are searching *Dependencies*, in which case you will need to use [the depgrep query language](depgrep.md). If you're new to regular expressions, and just want to find words that exactly match a string, enter `^word$`. The caret (`^`) denotes 'start of string', and the dollar sign (`$`) denotes the end of string. Without the dollar sign, the query would match not only *word*, but *wordy*, *wording*, *word-salad*, and so on.

**Inverting searches**: finally, you can toggle result inversion using the toggle switch (i.e. return rows *not matching* the search criteria). This is especially useful if you want to remove particular unwanted results. For example, if you want to match any pronoun but *me*, rather than writing a regular expression to match every other pronoun (*I*, *you*, *he*, etc.), simple search for any token whose part of speech is *PRP*, and then run another search for any word matching *me*, inverting the result.

Expand All @@ -50,7 +50,7 @@ Alternatively, you could write one *depgrep* query:
X"NOUN" = w/ing$/ != F"nsubj"
```

If you want to learn to use the *depgrep* language, check out [its documentation on GitHub](https://github.com/interrogator/depgrep).
If you want to learn to use the *depgrep* language, you can view the [*depgrep* page](depgrep.md) for a guide to query construction.

At any time, if you want to delete your search history, you can use the 'Clear history' button to forget all previous searches.

Expand Down

0 comments on commit 9a826c9

Please sign in to comment.