Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dasmith committed Sep 14, 2010
1 parent 39e6c78 commit 1b25af9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -11,7 +11,7 @@ First you must obtain and install the FrameNet XML files, which are free for non

Second, you should set your `FRAMENET_HOME` environment variable to point to where you installed and uncompressed FrameNet's XML files. (Alternatively you can edit the `FRAMENET_PATH` constant in `framenet/settings.py`).

Then you can test your installation by running `python test/importer.py` or opening a Python shell and typing:
Then you can test your installation by running `python test/importer.py` or by opening a Python shell and typing:

import framenet
fn = framenet.FrameNet()
Expand All @@ -21,18 +21,18 @@ The first time you instantiate the **FrameNet** class, it will parse *all* of th
Loading the frames ... Framenet not initialized, doing it now
Loading xml for frames ...

The first time you do this, this will take a while, so go have a coffee or celebrate your next birthday.
The first time you do this it will take a while, so go have a coffee or celebrate your next birthday.

# Common Functions


* `FrameNet.lookupLexicalUnit(text, part_of_speech)`
* **FrameNet.lookupLexicalUnit(text, part_of_speech)**

You can look up frames by the **lexical units** (e.g., words) and their parts of speech. For example:

buy = fn.lookupLexicalUnit('buy','v')

* `FrameNet.lookupFrame(frame)`
* **FrameNet.lookupFrame(frame)**

Also, you can look up [FrameNet frames](http://framenet.icsi.berkeley.edu/index.php?option=com_wrapper&Itemid=113) by their name:

Expand Down

0 comments on commit 1b25af9

Please sign in to comment.