<commit_before>===========
 Use Cases
===========

Below are some usecases written to demonstrate proposed APIs during
development.  **Note: This document is slightly dated.**

Interface Convenience API
-------------------------

Eventually we will be using nipy image objects::
<commit_msg>Add note on use cases.<commit_after>===========
 Use Cases
===========

Below are some usecases written to demonstrate proposed APIs during
development.  **Note: These notes were taking during the Spring
of 2009.  This may not accurately represent the current design of the
software.**

Interface Convenience API
-------------------------

Eventually we will be using nipy image objects::

{'fraction_non_alphanumeric': 0.17647058823529413, 'fraction_numerical': 0.0058823529411764705, 'mean_word_length': 3.450980392156863, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2060841', 'n_tokens_mistral': 169, 'n_tokens_neox': 151, 'n_words': 81}