Skip to content

docs: add License, Citation, and Limitations sections to README#53

Open
vominh1919 wants to merge 1 commit intoNousResearch:mainfrom
vominh1919:docs/enhancement
Open

docs: add License, Citation, and Limitations sections to README#53
vominh1919 wants to merge 1 commit intoNousResearch:mainfrom
vominh1919:docs/enhancement

Conversation

@vominh1919
Copy link
Copy Markdown

Description

This PR addresses issue #51 by enhancing the README documentation with the following additions:

  1. License Section: Added MIT License information with a link to the LICENSE file and the full license text.

  2. Citation Section: Added a BibTeX citation block for academic users who want to reference this work.

  3. Limitations and Risks Section: Added comprehensive documentation covering:

    • Model hallucinations warning
    • Function calling accuracy considerations
    • Financial data disclaimer (yfinance API data may be delayed/inaccurate)
    • Security considerations for production deployments
    • Bias and fairness notice
    • Resource requirements

Checklist

  • License is now mentioned in README
  • Limitations/risks are now documented
  • Added citation section for academic use

- Add MIT License section with link to LICENSE file
- Add BibTeX citation section for academic use
- Add Limitations and Risks section covering:
  - Model hallucinations warning
  - Function calling accuracy considerations
  - Financial data disclaimer
  - Security considerations
  - Bias and fairness notice
  - Resource requirements

Addresses NousResearch#51
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.

1 participant