Documentation

[alvesisaque]

Motivation

Updates all project documentation, including readme and more general structures

Changes

• README.md
• code documentation
• update page documentation

[apmt]

1.a I guess the branch name could follow the contribuition guilines x/issue_name, where x represents the issue

[apmt]

1.b need to undo the identation changes in order to run this code and pass the tests

[apmt]

2. Some links in the documentation are not working, like:

• Indices and tables -> Index
• Indices and tables -> Module Index
• Indices and tables -> Search Page
• Show Source

[apmt]

3. I guess would be a good thing to try to fix the code blocs examples format, like in here

[apmt]

4. We could also try to set this sphinix param to True, in order to test if this would better format this part of the docstring:

:param df: Dataframe to extract word embedding features from.
:type df: pandas.DataFrame
:param column_name: Name of the column in the dataframe that contains the text data to extract features from.
:type column_name: str
:param normalize: Indicates whether to normalize the word embedding feature columns. Default is True.
:type normalize: bool, optional

[codecov]

Codecov Report

Base: 79.89% // Head: 79.89% // No change to project coverage 👍

Coverage data is based on head (2fc29c9) compared to base (42488ee).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #71   +/-   ##
=======================================
  Coverage   79.89%   79.89%           
=======================================
  Files          31       31           
  Lines         965      965           
=======================================
  Hits          771      771           
  Misses        194      194           

Impacted Files	Coverage Δ
hygia/data_pipeline/annotate_data/annotate_data.py	90.00% <ø> (ø)
hygia/data_pipeline/augment_data/augment_data.py	96.15% <ø> (ø)
...ipeline/feature_engineering/feature_engineering.py	100.00% <ø> (ø)
...gia/data_pipeline/feature_engineering/key_smash.py	94.33% <ø> (ø)
hygia/data_pipeline/feature_engineering/regex.py	83.60% <ø> (ø)
...ata_pipeline/feature_engineering/word_embedding.py	70.00% <ø> (ø)
hygia/data_pipeline/model/random_forest.py	34.17% <ø> (ø)
...data_pipeline/pre_process_data/pre_process_data.py	59.09% <ø> (ø)
... and 6 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[Bruno-Felix]

Show!!