<commit_before>System's objectives
========

The system should analyze a number of texts and be able to perform topic modeling. 
The system should find ten topics in the given text dataset, how the companies are different in term of their letters, and visualize the results.

Information inputs
~~~~~~~~~~~~~~~~~~~~~~
Five companies' shareholders letter from 1996 to 2003. There are 48 documents. 
CSV file. 

Information outputs
~~~~~~~~~~~~~~~~~~~~~~
-  Ten topics
-  Heatmap
-  Topic shares associated with each company
-  Distance between companies by topics.

Web Services and/or APIs
~~~~~~~~~~~~~~~~~~~~~~
This application does not use web services and APIs

Third-party Python Packages
~~~~~~~~~~~~~~~~~~~~~~
This application uses NumPy, Scikit-learn, and Matplotlib.

.. figure:: https://github.com/lkc9015/freestyle_project/blob/master/planning/Heatmap.png
   :alt: heatmap icon
   
**Heatmap result**


      

 <commit_msg>Update PLANNING.rst<commit_after>System's objectives
========

The system should analyze a number of texts and be able to perform topic modeling. 
The system should find ten topics in the given text dataset, how the companies are different in term of their letters, and visualize the results.

Information inputs
~~~~~~~~~~~~~~~~~~~~~~
Five companies' shareholders letter from 1996 to 2003. There are 48 documents. 
CSV file. 

Information outputs
~~~~~~~~~~~~~~~~~~~~~~
-  Ten topics
-  Heatmap
-  Topic shares associated with each company
-  Distance between companies by topics.

Web Services and/or APIs
~~~~~~~~~~~~~~~~~~~~~~
This application does not use web services and APIs

Third-party Python Packages
~~~~~~~~~~~~~~~~~~~~~~
This application uses NumPy, Scikit-learn, and Matplotlib.

.. figure:: 
   :alt: heatmap icon
   
**Heatmap result**


      

 
{'fraction_non_alphanumeric': 0.15008337965536409, 'fraction_numerical': 0.013340744858254585, 'mean_word_length': 4.373134328358209, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, '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': '3586235', 'n_tokens_mistral': 501, 'n_tokens_neox': 438, 'n_words': 208}