Add literature references to the README.md #146
Conversation
WalkthroughThe recent update to the repository involves adding references to the README.md file for publications by H. Park et al and A. Onwuli et al. No alterations were made to the declarations of exported or public entities. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~24-~24: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... these involve the use of deep learning techniques where the representation of the element...
[uncategorized] ~34-~34: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...mbeddings's main feature, the Embedding class is accessible by importing the class. ...
[uncategorized] ~140-~140: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ing through theembeddingandstatsarguments respectively. ```python from elementem...
Markdownlint
README.md
181-181: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
182-182: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
172-172: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
185-185: null (MD047, single-trailing-newline)
Files should end with a single newline character
Additional comments not posted (2)
README.md (2)
183-183: Literature reference added correctly.The reference to H. Park et al. has been formatted correctly and includes a working URL.
185-185: Literature reference added correctly.The reference to A. Onwuli et al. has been formatted correctly and includes a working URL.
Tools
Markdownlint
185-185: null (MD047, single-trailing-newline)
Files should end with a single newline character
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #146 +/- ##
=======================================
Coverage 92.55% 92.55%
=======================================
Files 12 12
Lines 1047 1047
=======================================
Hits 969 969
Misses 78 78 ☔ View full report in Codecov by Sentry. |
Pull Request Template
Description
How Has This Been Tested?
N/A
Reviewers
Checklist:
Summary by CodeRabbit
README.mdwith references to publications by H. Park et al and A. Onwuli et al for further reading.