paper-hive


Namepaper-hive JSON
Version 0.0.1 PyPI version JSON
download
home_pagehttps://github.com/The-Swarm-Corporation/Research-Paper-Hive
SummaryRPH - Swarms Research Paper Hive
upload_time2024-09-12 20:13:19
maintainerNone
docs_urlNone
authorKye Gomez
requires_python<4.0,>=3.10
licenseMIT
keywords artificial intelligence deep learning optimizers prompt engineering
VCS
bugtrack_url
requirements torch zetascale swarms
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Research-Paper-Hive

[![Join our Discord](https://img.shields.io/badge/Discord-Join%20our%20server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/agora-999382051935506503) [![Subscribe on YouTube](https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@kyegomez3242) [![Connect on LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kye-g-38759a207/) [![Follow on X.com](https://img.shields.io/badge/X.com-Follow-1DA1F2?style=for-the-badge&logo=x&logoColor=white)](https://x.com/kyegomezb)


**Research-Paper-Hive** is an intelligent AI-powered application that helps you find and summarize research papers based on your preferences. Whether you're diving into a new research area or looking for papers tailored to specific topics, Research-Paper-Hive uses a swarm of AI agents to streamline your workflow by searching, analyzing, and summarizing relevant research papers for you.

## Features

- **Personalized Paper Search**: Input your preferences such as keywords, topics, or research fields, and Research-Paper-Hive will find relevant papers.
- **AI-Powered Summaries**: Agents collaborate to summarize each paper, providing you with concise and informative overviews.
- **Fast and Efficient**: With the power of swarm intelligence, Research-Paper-Hive processes and delivers results quickly.
- **Customizable Search Criteria**: Tailor your search by adjusting the specificity of your preferences.
- **Paper Ranking**: Get a ranked list of papers that are most aligned with your research interests.

## How It Works

1. **Input Preferences**: Provide Research-Paper-Hive with your specific preferences such as topics, keywords, or desired research fields.
2. **Agent Search**: A swarm of AI agents will search through academic databases to find the most relevant papers.
3. **Summarization**: Once papers are found, each agent works to generate concise summaries.
4. **Review and Download**: Review the summarized papers, ranked by relevance, and download the ones you need.

## Getting Started

### Prerequisites

Ensure you have the following installed:
- Python 3.10
- Required dependencies from `requirements.txt`

### Installation
```bash
$ pip3 install -U rph
```

### API Keys Setup
MedInsight Pro requires access to the OpenAI API, PubMed, and Semantic Scholar APIs. You’ll need to set up environment variables for these keys in your .env file:

```bash
OPENAI_API_KEY="your-openai-api-key"
WORKSPACE_ID="your-workspace-id" # Your workspace ID 
```


### Usage

```python

from rph.agent import summarize_papers

if __name__ == "__main__":
    summary = summarize_papers()
    print(summary)

```

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Open a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/The-Swarm-Corporation/Research-Paper-Hive",
    "name": "paper-hive",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "artificial intelligence, deep learning, optimizers, Prompt Engineering",
    "author": "Kye Gomez",
    "author_email": "kye@apac.ai",
    "download_url": "https://files.pythonhosted.org/packages/00/95/821eae0c7b30f863f1239bf4cfd9fc46db8574f26e19ca47ac0b5662cae1/paper_hive-0.0.1.tar.gz",
    "platform": null,
    "description": "# Research-Paper-Hive\n\n[![Join our Discord](https://img.shields.io/badge/Discord-Join%20our%20server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/agora-999382051935506503) [![Subscribe on YouTube](https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@kyegomez3242) [![Connect on LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kye-g-38759a207/) [![Follow on X.com](https://img.shields.io/badge/X.com-Follow-1DA1F2?style=for-the-badge&logo=x&logoColor=white)](https://x.com/kyegomezb)\n\n\n**Research-Paper-Hive** is an intelligent AI-powered application that helps you find and summarize research papers based on your preferences. Whether you're diving into a new research area or looking for papers tailored to specific topics, Research-Paper-Hive uses a swarm of AI agents to streamline your workflow by searching, analyzing, and summarizing relevant research papers for you.\n\n## Features\n\n- **Personalized Paper Search**: Input your preferences such as keywords, topics, or research fields, and Research-Paper-Hive will find relevant papers.\n- **AI-Powered Summaries**: Agents collaborate to summarize each paper, providing you with concise and informative overviews.\n- **Fast and Efficient**: With the power of swarm intelligence, Research-Paper-Hive processes and delivers results quickly.\n- **Customizable Search Criteria**: Tailor your search by adjusting the specificity of your preferences.\n- **Paper Ranking**: Get a ranked list of papers that are most aligned with your research interests.\n\n## How It Works\n\n1. **Input Preferences**: Provide Research-Paper-Hive with your specific preferences such as topics, keywords, or desired research fields.\n2. **Agent Search**: A swarm of AI agents will search through academic databases to find the most relevant papers.\n3. **Summarization**: Once papers are found, each agent works to generate concise summaries.\n4. **Review and Download**: Review the summarized papers, ranked by relevance, and download the ones you need.\n\n## Getting Started\n\n### Prerequisites\n\nEnsure you have the following installed:\n- Python 3.10\n- Required dependencies from `requirements.txt`\n\n### Installation\n```bash\n$ pip3 install -U rph\n```\n\n### API Keys Setup\nMedInsight Pro requires access to the OpenAI API, PubMed, and Semantic Scholar APIs. You\u2019ll need to set up environment variables for these keys in your .env file:\n\n```bash\nOPENAI_API_KEY=\"your-openai-api-key\"\nWORKSPACE_ID=\"your-workspace-id\" # Your workspace ID \n```\n\n\n### Usage\n\n```python\n\nfrom rph.agent import summarize_papers\n\nif __name__ == \"__main__\":\n    summary = summarize_papers()\n    print(summary)\n\n```\n\n## Contributing\n\nContributions are welcome! Please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Commit your changes (`git commit -m 'Add new feature'`).\n4. Push to the branch (`git push origin feature-branch`).\n5. Open a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "RPH - Swarms Research Paper Hive",
    "version": "0.0.1",
    "project_urls": {
        "Documentation": "https://github.com/The-Swarm-Corporation/Research-Paper-Hive",
        "Homepage": "https://github.com/The-Swarm-Corporation/Research-Paper-Hive",
        "Repository": "https://github.com/The-Swarm-Corporation/Research-Paper-Hive"
    },
    "split_keywords": [
        "artificial intelligence",
        " deep learning",
        " optimizers",
        " prompt engineering"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e38ed7e9bbf23353a43aa2a852bf6afe46ee548c5588388744638edf10901b8c",
                "md5": "d86cc318c1bcec5aa10f174753ca74e2",
                "sha256": "8364fac33b178c2362c13f2ecde8e696fa24847b72341575dd505f779784192d"
            },
            "downloads": -1,
            "filename": "paper_hive-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d86cc318c1bcec5aa10f174753ca74e2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 7373,
            "upload_time": "2024-09-12T20:13:17",
            "upload_time_iso_8601": "2024-09-12T20:13:17.928534Z",
            "url": "https://files.pythonhosted.org/packages/e3/8e/d7e9bbf23353a43aa2a852bf6afe46ee548c5588388744638edf10901b8c/paper_hive-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0095821eae0c7b30f863f1239bf4cfd9fc46db8574f26e19ca47ac0b5662cae1",
                "md5": "96a6ada2f2b47ee7b42c450959906ab4",
                "sha256": "5c05bce9ee5f5f946bbbfbfd9a4ebaaec2c30bdd6f9748762c8684059cc22145"
            },
            "downloads": -1,
            "filename": "paper_hive-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "96a6ada2f2b47ee7b42c450959906ab4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 6747,
            "upload_time": "2024-09-12T20:13:19",
            "upload_time_iso_8601": "2024-09-12T20:13:19.852756Z",
            "url": "https://files.pythonhosted.org/packages/00/95/821eae0c7b30f863f1239bf4cfd9fc46db8574f26e19ca47ac0b5662cae1/paper_hive-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-12 20:13:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "The-Swarm-Corporation",
    "github_project": "Research-Paper-Hive",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "torch",
            "specs": []
        },
        {
            "name": "zetascale",
            "specs": []
        },
        {
            "name": "swarms",
            "specs": []
        }
    ],
    "lcname": "paper-hive"
}
        
Elapsed time: 0.40439s