Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor citations to simplify code and improve docs (closes #303) #317

Merged
merged 2 commits into from
Mar 28, 2024

Conversation

oshoma
Copy link
Collaborator

@oshoma oshoma commented Mar 27, 2024

This is a new version of #303, rebased on latest origin/main.

This PR adds two new "TODO" tests that are skipped.

Your checklist for this pull request

Thank you for submitting a pull request! To speed up the review process, please follow this checklist:

  • My Pull Request is small and focused on one topic so it can be reviewed easily
  • My code follows the style guidelines of this project (make format)
  • Commit messages are detailed
  • I have performed a self-review of my code
  • I commented hard-to-understand parts of my code
  • I updated the documentation (docstrings, /docs)
  • My changes generate no new warnings (or explain any new warnings and why they're ok)
  • I have added tests that prove my fix is effective or that my feature works
  • All tests pass when I run pytest tests (offline mode)

Additional steps for code with networking dependencies:

@oshoma oshoma self-assigned this Mar 27, 2024
@20001LastOrder 20001LastOrder self-requested a review March 28, 2024 03:16
ChenKua and others added 2 commits March 27, 2024 23:17
In general:
- improve function and variable naming
- reformat docstrings
- remove unneccesary docstring text

Add_citation_to_sentence
- simplify
- stop adding citations after adding success (cited = True)
- do not calculate similarity comparisons unless they're needed
- return immediately for short sentences

Add a bit more detail to tests, and some TODO tests
Copy link
Collaborator

@20001LastOrder 20001LastOrder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@20001LastOrder 20001LastOrder merged commit 6a20191 into Aggregate-Intellect:main Mar 28, 2024
@oshoma oshoma deleted the refactor-citations branch March 29, 2024 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants