Skip to content

Commit

Permalink
Update URL
Browse files Browse the repository at this point in the history
  • Loading branch information
oeway committed Jun 6, 2024
1 parent 08c90d6 commit 41aeb26
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Welcome to the BioImage.IO Chatbot user guide. This guide will help you get the
The BioImage.IO Chatbot is a versatile conversational agent designed to assist users in accessing information related to computational bioimaging. It leverages the power of Large Language Models (LLMs) and integrates user-specific data to provide contextually accurate and personalized responses. Whether you're a researcher, developer, or scientist, the chatbot is here to make your bioimaging journey smoother and more informative.


![screenshot for the chatbot](./docs/screenshots/chatbot-animation.gif)
![screenshot for the chatbot](./screenshots/chatbot-animation.gif)

The following diagram shows how the chatbot works:

Expand Down Expand Up @@ -45,7 +45,7 @@ The BioImage.IO Chatbot is equipped with an array of capabilities designed to en

We are providing a public chatbot service for you to try out. You can access the chatbot [here](https://chat.bioimage.io/chat).

Please note that the chatbot is still in beta and is being actively developed, we will log the message you input into the chatbot for further investigation of issues and support our development. See the [Disclaimer for BioImage.IO Chatbot](./docs/DISCLAIMER.md). If you want to to remove your chat logs, please contact us via [this form](https://oeway.typeform.com/to/K3j2tJt7).
Please note that the chatbot is still in beta and is being actively developed, we will log the message you input into the chatbot for further investigation of issues and support our development. See the [Disclaimer for BioImage.IO Chatbot](./DISCLAIMER.md). If you want to to remove your chat logs, please contact us via [this form](https://oeway.typeform.com/to/K3j2tJt7).

Here you can find usage guide and more examples: [Usage guide and example screenshots](docs/usage-example.md).

Expand All @@ -63,15 +63,15 @@ The chatbot uses your user profile information, such as your name, occupation, a

## Setup Your Own Chatbot

You can also set up your own chatbot server. Please refer to the [installation guide](./docs/installation.md) for detailed instructions on how to set up the chatbot server on your local machine or server.
You can also set up your own chatbot server. Please refer to the [installation guide](./installation.md) for detailed instructions on how to set up the chatbot server on your local machine or server.

## Technical Overview

Please read the [technical overview](./docs/technical-overview.md) for more details about the chatbot's design and implementation.
Please read the [technical overview](./technical-overview.md) for more details about the chatbot's design and implementation.

## Develop Chatbot Extensions

The BioImage.IO Chatbot is designed to be extensible, allowing developers to create custom extensions to add new functionalities to the chatbot. You can create extensions to integrate new tools, databases, and services into the chatbot, making it more powerful and versatile. See the [development guide](./docs/development.md) for more details.
The BioImage.IO Chatbot is designed to be extensible, allowing developers to create custom extensions to add new functionalities to the chatbot. You can create extensions to integrate new tools, databases, and services into the chatbot, making it more powerful and versatile. See the [development guide](./development.md) for more details.

## Join Us as a Community Partner

Expand All @@ -92,7 +92,7 @@ Thanks for your support and helping make the BioImage.IO Chatbot more informativ
For detailed description of our work, please read our preprint: **[![arXiv](https://img.shields.io/badge/arXiv-2310.18351-red.svg)](https://arxiv.org/abs/2310.18351) <a href="https://zenodo.org/records/10032227" target="_blank"><img id="record-doi-badge" data-target="[data-modal='10.5281/zenodo.10032227']" src="https://zenodo.org/badge/DOI/10.5281/zenodo.10032227.svg" alt="10.5281/zenodo.10032227"></a>**


To reproduce the use cases described in [Figure 2](https://docs.google.com/drawings/d/e/2PACX-1vTIRwRldQBnTFqz0hvS01znGOEdoeDMJmZC-PlBM-O59u_xo7DfJlUEE9SlRsy6xO1hT2HuSOBrLmUz/pub?w=1324&amp;h=1063) in the manuscript, please refer to the [reproducing example usage scenarios](./docs/figure-2-use-cases.md).
To reproduce the use cases described in [Figure 2](https://docs.google.com/drawings/d/e/2PACX-1vTIRwRldQBnTFqz0hvS01znGOEdoeDMJmZC-PlBM-O59u_xo7DfJlUEE9SlRsy6xO1hT2HuSOBrLmUz/pub?w=1324&amp;h=1063) in the manuscript, please refer to the [reproducing example usage scenarios](./figure-2-use-cases.md).

<img style="width:300px;" src="https://docs.google.com/drawings/d/e/2PACX-1vTIRwRldQBnTFqz0hvS01znGOEdoeDMJmZC-PlBM-O59u_xo7DfJlUEE9SlRsy6xO1hT2HuSOBrLmUz/pub?w=1324&amp;h=1063">

Expand Down
4 changes: 2 additions & 2 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- docs/_sidebar.md -->
* [Overview](/overview)
* [Overview](/README)
* [Installation](/installation)
* [Usage guide and example screenshots](/usage-example)
* [Usage guide](/usage-example)
* [Technical Overview](/technical-overview)
* [Extension Development](/development)
* [Contribution Guidelines](/CONTRIBUTING)
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Open the link in a browser, and you will see the chat interface.

Please note that the chatbot server may not be accessible to users outside your local network.

A user guide and technical overview can be found [here](./docs/technical-overview.md).
A user guide and technical overview can be found [here](./technical-overview.md).

To be able to share your chatbot service over the internet (especially for users outside your local network), you will need to expose your server publicly. Please, see [Connect to Server](#connect-to-server)

Expand Down

0 comments on commit 41aeb26

Please sign in to comment.