Skip to content

Commit

Permalink
Some minor documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bhargav authored Mar 12, 2017
1 parent a1a7269 commit ce9450a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion saul-core/doc/CONCEPTUALSTRUCTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ val pos = property(token, isStatic = true) {
The first time that a property is called with a specific value, it would you remember the corresponding output,
so next time it just looks up the value from the cache.

**Note:** `isStatic` caches the value for the lifetime of the training process.
**Note:** `isStatic` caches the value for the lifetime of the training process. Make sure you have enough free memory (RAM) available to store the cache in-memory.

If you want the value to be cache only during a single iteration, use the `cache` parameter. The `cache` parameter allows the value to be cached within a training/testing iteration. This is useful if you one of your features depends on evaluation of a Classifier on other instances as well. This recursive evaluation of the Classifier might be expensive and caching would speed-up performance. Look at a sample usage of this parameter in the [POSTagging Example](../../saul-examples/src/main/scala/edu/illinois/cs/cogcomp/saulexamples/nlp/POSTagger/POSDataModel.scala#L66).

Expand Down

0 comments on commit ce9450a

Please sign in to comment.