Skip to content

Commit

Permalink
Merge branch 'main' into feat/add-streaming-response
Browse files Browse the repository at this point in the history
  • Loading branch information
gurdeep330 authored Feb 10, 2025
2 parents 05c2648 + a321618 commit 87dc98d
Show file tree
Hide file tree
Showing 8 changed files with 117 additions and 164 deletions.
122 changes: 30 additions & 92 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,23 @@
[![Talk2BioModels](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2biomodels.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2biomodels.yml)
[![Talk2Cells](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2cells.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2cells.yml)
[![Talk2KnowledgeGraphs](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2knowledgegraphs.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2knowledgegraphs.yml)
[![Talk2Scholars](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2scholars.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2scholars.yml)
[![TESTS Talk2Scholars](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2scholars.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2scholars.yml)
![GitHub Release](https://img.shields.io/github/v/release/VirtualPatientEngine/AIAgents4Pharma)
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FVirtualPatientEngine%2FAIAgents4Pharma%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)

<h1 align="center" style="border-bottom: none;">🤖 AIAgents4Pharma</h1>

Welcome to **AIAgents4Pharma** – an open-source project by [Team VPE](https://github.com/VirtualPatientEngine) that brings together AI-driven tools to help researchers and pharma interact seamlessly with complex biological data.

Our toolkit currently consists of three intelligent agents, each designed to simplify and enhance access to specialized data in biology:

- **Talk2BioModels**: Engage directly with mathematical models in systems biology.
- **Talk2Cells** _(Work in progress)_: Query and analyze sequencing data with ease.
- **Talk2KnowledgeGraphs** _(Work in progress)_: Access and explore complex biological knowledge graphs for insightful data connections.
- **Talk2Scholars** _(Coming soon)_: Get recommendations for articles related to your choice. Download, query, and write/retrieve them to your reference manager (currently supporting Zotero).

---

## Overview of Agents

### 1. Talk2BioModels

**Talk2BioModels** is an AI agent designed to facilitate interaction with mathematical models in systems biology. Systems biology models are critical in understanding complex biological mechanisms, but they’re often inaccessible to those without coding or mathematical expertise. Talk2BioModels simplifies this, enabling researchers to focus on analysis and interpretation rather than on programming. With Talk2BioModels, users can interact directly with these models through natural language. By simply asking questions or making requests, users can:

- Forward simulation of both internal and open-source models (BioModels).
- Adjust parameters within the model to simulate different conditions.
- Query simulation results.
- Extract model information such as species, parameters, units and description.

### 2. Talk2Cells _(Work in Progress)_

**Talk2Cells** is being developed to provide direct access to and analysis of sequencing data, such as RNA-Seq or DNA-Seq, using natural language.
## Introduction

### 3. Talk2KnowledgeGraphs _(Work in Progress)_
Welcome to **AIAgents4Pharma** – an open-source project by [Team VPE](https://github.com/VirtualPatientEngine) that brings together AI-driven tools to help researchers and pharma interact seamlessly with complex biological data.

**Talk2KnowledgeGraphs** is an agent designed to enable interaction with biological knowledge graphs (KGs). KGs integrate vast amounts of structured biological data into a format that highlights relationships between entities, such as proteins, genes, and diseases.
Our toolkit currently consists of the following agents:

### 4. Talk2Scholars _(Work in Progress)_
- **Talk2BioModels** _(v1 released; v2 in progress)_: Engage directly with mathematical models in systems biology.
- **Talk2KnowledgeGraphs** _(v1 in progress)_: Access and explore complex biological knowledge graphs for insightful data connections.
- **Talk2Scholars** _(v1 in progress)_: Get recommendations for articles related to your choice. Download, query, and write/retrieve them to your reference manager (currently supporting Zotero).
- **Talk2Cells** _(v1 in progress)_: Query and analyze sequencing data with ease.

Talk2Scholars is an AI-powered hierarchical agent system designed to revolutionize academic paper search and analysis. Through intelligent conversation, users can discover, analyze, and receive recommendations for academic papers using state-of-the-art natural language processing.
![AIAgents4Pharma](docs/assets/AIAgents4Pharma.png)

## Getting Started

Expand All @@ -58,65 +36,36 @@ Check out the tutorials on each agent for detailed instrcutions.
#### Option 2: git

1. **Clone the repository:**

```bash
git clone https://github.com/VirtualPatientEngine/AIAgents4Pharma
cd AIAgents4Pharma
```

2. **Install dependencies:**

```bash
pip install .
```

3. **Initialize OPENAI_API_KEY**

```bash
export OPENAI_API_KEY=....
```

4. **[Optional] Set up login credentials**

```bash
vi .streamlit/secrets.toml
```

and enter

```
password='XXX'
```

Please note that the passoword will be same for all the users.

5. **[Optional] Initialize LANGSMITH_API_KEY**

4. **[Optional] Initialize LANGSMITH_API_KEY**
```bash
export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_API_KEY=<your-api-key>
```
_Please note that this will create a new tracing project in your Langsmith
account with the name `T2X-xxxx`, where `X` can be `B` (Biomodels), `S` (Scholars),
`KG` (KnowledgeGraphs), or `C` (Cells). If you skip the previous step, it will
default to the name `default`. `xxxx` will be the 4-digit ID created for the
session._

Please note that this will create a new tracing project in your Langsmith
account with the name `<user_name>@<uuid>`, where `user_name` is the name
you provided in the previous step. If you skip the previous step, it will
default to `default`. <uuid> will be the 128 bit unique ID created for the
session.

6. **Launch the app:**
5. **Launch the app:**
```bash
streamlit run app/frontend/streamlit_app.py
streamlit run app/frontend/streamlit_app_<agent>.py
```
_Replace <agent> with the agent name you are interested to launch._

For detailed instructions on each agent, please refer to their respective folders.

---

## Usage

**Talk2BioModels** currently provides an interactive console where you can enter natural language queries to simulate models, adjust parameters, and query the simulated results.

More detailed usage examples, including sample data for Talk2Cells and Talk2KnowledgeGraphs, will be provided as development progresses.
For detailed instructions on each agent, please refer to their respective modules.

---

Expand All @@ -128,36 +77,25 @@ We welcome contributions to AIAgents4Pharma! Here’s how you can help:
2. **Create a new branch** for your feature (`git checkout -b feat/feature-name`)
3. **Commit your changes** (`git commit -m 'feat: Add new feature'`)
4. **Push to the branch** (`git push origin feat/feature-name`)
5. **Open a pull request**

### Current Needs
5. **Open a pull request** and reach out to any one of us below via Discussions:

- **Beta testers** for Talk2BioModels.
- **Developers** with experience in natural language processing, bioinformatics, or knowledge graphs for contributions to AIAgents4Pharma.
_Note: We welcome all contributions, not just programming-related ones. Feel free to open bug reports, suggest new features, or participate as a beta tester. Your support is greatly appreciated!_

Check out our [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

---
- **Talk2Biomodels/Talk2Cells**: [@gurdeep330](https://github.com/gurdeep330) [@lilijap](https://github.com/lilijap) [@dmccloskey](https://github.com/dmccloskey)
- **Talk2KnowledgeGraphs**: [@awmulyadi](https://github.com/awmulyadi) [@dmccloskey](https://github.com/dmccloskey)
- **Talk2Scholars**: [@ansh-info](https://github.com/ansh-info) [@gurdeep330](https://github.com/gurdeep330) [@dmccloskey](https://github.com/dmccloskey)

## Roadmap

### Completed

- **Talk2BioModels**: Initial release with core capabilities for interacting with systems biology models.

### Planned
### Current Needs

- **User Interface**: Interactive web UI for all agents.
- **Talk2Cells**: Integration of sequencing data analysis tools.
- **Talk2KnowledgeGraphs**: Interface for biological knowledge graph interaction.
- **Talk2Scholars**: Interface for exploring articles
- **Beta testers** for Talk2BioModels and Talk2Scholars.
- **Developers** with experience in Python and Bioinformatics and/or knowledge graphs for contributions to AIAgents4Pharma.

We’re excited to bring AIAgents4Pharma to the bioinformatics and pharmaceutical research community. Together, let’s make data-driven biological research more accessible and insightful.
Feel free to reach out to us via Discussions.

**Get Started** with AIAgents4Pharma today and transform the way you interact with biological data.
Check out our [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

---

## Feedback

Questions/Bug reports/Feature requests/Comments/Suggestions? We welcome all. Please use the `Isssues` tab 😀
Questions/Bug reports/Feature requests/Comments/Suggestions? We welcome all. Please use `Isssues` or `Discussions` 😀
Binary file added docs/assets/AIAgents4Pharma.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
97 changes: 58 additions & 39 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,101 @@
<h1 align="center" style="font-weight: bold;">🤖 AIAgents4Pharma</h1>
[![Talk2BioModels](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2biomodels.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2biomodels.yml)
[![Talk2Cells](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2cells.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2cells.yml)
[![Talk2KnowledgeGraphs](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2knowledgegraphs.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2knowledgegraphs.yml)
[![TESTS Talk2Scholars](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2scholars.yml/badge.svg)](https://github.com/VirtualPatientEngine/AIAgents4Pharma/actions/workflows/tests_talk2scholars.yml)
![GitHub Release](https://img.shields.io/github/v/release/VirtualPatientEngine/AIAgents4Pharma)
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FVirtualPatientEngine%2FAIAgents4Pharma%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)

Welcome to **AIAgents4Pharma** – an open-source project by [Team VPE](https://github.com/VirtualPatientEngine) that brings together AI-driven tools to help researchers and pharma interact seamlessly with complex biological data.

Our toolkit currently consists of three agents, each designed to simplify and enhance access to complex data in biology:
## Introduction

- [**Talk2BioModels**](talk2biomodels/models/intro.md): Engage directly with mathematical models in systems biology.
Welcome to **AIAgents4Pharma** – an open-source project by [Team VPE](https://github.com/VirtualPatientEngine) that brings together AI-driven tools to help researchers and pharma interact seamlessly with complex biological data.

- [**Talk2Cells**](talk2cells/intro.md) *(Work in progress)*: Query and analyze sequencing data with ease.
Our toolkit currently consists of the following agents:

- [**Talk2KnowledgeGraphs**](talk2knowledgegraphs/intro.md) *(Coming soon)*: Access and explore complex biological knowledge graphs for insightful data connections.
- **Talk2BioModels** _(v1 released; v2 in progress)_: Engage directly with mathematical models in systems biology.
- **Talk2KnowledgeGraphs** _(v1 in progress)_: Access and explore complex biological knowledge graphs for insightful data connections.
- **Talk2Scholars** _(v1 in progress)_: Get recommendations for articles related to your choice. Download, query, and write/retrieve them to your reference manager (currently supporting Zotero).
- **Talk2Cells** _(v1 in progress)_: Query and analyze sequencing data with ease.

- [**Talk2Scholars**](talk2scholars/intro.md) *(Coming soon)*: Access articles and receive recommendations for academic papers using state-of-the-art natural language processing
![AIAgents4Pharma](assets/AIAgents4Pharma.png)

### Prerequisites
## Getting Started

- **Python 3.10+**
- **Git**
- Required libraries specified in `requirements.txt`
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FVirtualPatientEngine%2FAIAgents4Pharma%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)

### Installation

#### Option 1: PyPI
```bash
pip install aiagents4pharma
```

```bash
pip install aiagents4pharma
```

Check out the tutorials on each agent for detailed instrcutions.

#### Option 2: Git
#### Option 2: git

1. **Clone the repository:**
```bash
git clone https://github.com/VirtualPatientEngine/AIAgents4Pharma
cd AIAgents4Pharma
```

2. **Install dependencies:**
```bash
pip install -r requirements.txt
pip install .
```

3. **Initialize OPENAI_API_KEY**
```bash
export OPENAI_API_KEY=....
```

4. **[Optional] Set up login credentials**
```bash
vi .streamlit/secrets.toml
```
and enter
```
password='XXX'
```
Please note that the password will be same for all.

5. **[Optional] Initialize LANGSMITH_API_KEY**
4. **[Optional] Initialize LANGSMITH_API_KEY**
```bash
export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_API_KEY=<your-api-key>
```
Please note that this will create a new tracing project in your Langsmith
account with the name `<user_name>@<uuid>`, where `user_name` is the name
you provided in the previous step. If you skip the previous step, it will
default to `default` (a 128 bit unique ID created for the session).
_Please note that this will create a new tracing project in your Langsmith
account with the name `T2X-xxxx`, where `X` can be `B` (Biomodels), `S` (Scholars),
`KG` (KnowledgeGraphs), or `C` (Cells). If you skip the previous step, it will
default to the name `default`. `xxxx` will be the 4-digit ID created for the
session._

6. **Launch the app:**
5. **Launch the app:**
```bash
streamlit run app/frontend/streamlit_app.py
streamlit run app/frontend/streamlit_app_<agent>.py
```
_Replace <agent> with the agent name you are interested to launch._

For detailed instructions on each agent, please refer to their respective modules.

### Contributing
---

## Contributing

We welcome contributions to AIAgents4Pharma! Here’s how you can help:

1. **Fork the repository**
2. **Create a new branch** for your feature (`git checkout -b feat/feature-name`)
3. **Commit your changes** (`git commit -m 'feat: Add new feature'`)
4. **Push to the branch** (`git push origin feat/feature-name`)
5. **Open a pull request**
5. **Open a pull request** and reach out to any one of us below via Discussions:

_Note: We welcome all contributions, not just programming-related ones. Feel free to open bug reports, suggest new features, or participate as a beta tester. Your support is greatly appreciated!_

- **Talk2Biomodels/Talk2Cells**: [@gurdeep330](https://github.com/gurdeep330) [@lilijap](https://github.com/lilijap) [@dmccloskey](https://github.com/dmccloskey)
- **Talk2KnowledgeGraphs**: [@awmulyadi](https://github.com/awmulyadi) [@dmccloskey](https://github.com/dmccloskey)
- **Talk2Scholars**: [@ansh-info](https://github.com/ansh-info) [@gurdeep330](https://github.com/gurdeep330) [@dmccloskey](https://github.com/dmccloskey)

### Current Needs

- **Beta testers** for Talk2BioModels and Talk2Scholars.
- **Developers** with experience in Python and Bioinformatics and/or knowledge graphs for contributions to AIAgents4Pharma.

Feel free to reach out to us via Discussions.

Check out our [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

---

## Feedback

Check out our [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
Questions/Bug reports/Feature requests/Comments/Suggestions? We welcome all. Please use `Isssues` or `Discussions` 😀
Binary file added docs/t2b_diagram_latest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions docs/talk2biomodels/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Talk2BioModels

**Talk2BioModels** is an AI-agent designed to interact with mathematical models in systems biology. You can choose to either interact with a model available in the BioModels database or upload your own model.



### How to access Talk2BioModels?

There are 2 ways to access Talk2BioModels:

- **Set up the Streamlit app**: Follow the instructions on the home page to set up an launch the Streamlit app.
- **Use the PyPI package**: Follow the tutorial for step-by-step guidance on how to use the PyPI package.

22 changes: 0 additions & 22 deletions docs/talk2biomodels/models/intro.md

This file was deleted.

Loading

0 comments on commit 87dc98d

Please sign in to comment.