Skip to content

Commit ffaee62

Browse files
committed
Updated documentation
1 parent 9fc39ca commit ffaee62

4 files changed

Lines changed: 28 additions & 159 deletions

File tree

ai-assistant.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,31 +18,21 @@ https://github.com/acceleratedscience/open-ad-toolkit/tree/main/docs
1818

1919
---
2020

21-
- **Supported LLMs** are [IBM BAM] and [Ollama]
21+
- **Supported LLMs** [Ollama]
2222
- **Ollama** requires an 8GB GPU.
23-
- **WatsonX support** is coming soon.
2423

2524
---
2625

2726
<br>
2827

29-
## IBM BAM Setup
30-
31-
To use [IBM BAM] if you have access to it, simply provide your API key when prompted.
32-
33-
set llm bam
34-
tell me <enter prompt>
35-
36-
<br>
37-
3828
## Ollama Setup
3929

4030
1. Install [Ollama] onto your platform.
4131

4232
2. Download the appropriate models.
4333

44-
ollama pull llama3:latest
45-
ollama pull nomic-embed-text
34+
ollama pull granite3.1-dense:8b-instruct-q4_1
35+
ollama pull all-minilm:l6-v2
4636

4737
3. Start the server if not already started.
4838

@@ -69,5 +59,4 @@ That's it for local usage. If you want to run Ollama remotely, continue below.
6959
set llm ollama
7060
tell me <enter prompt>
7161

72-
[IBM BAM]: https://bam.res.ibm.com
7362
[Ollama]: https://ollama.com

commands.md

Lines changed: 0 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -134,85 +134,13 @@ Lists all your workspaces. <br>
134134

135135
### Toolkits
136136

137-
<details markdown="block" class="cmd-wrap">
138-
<summary markdown="block">
139-
`ds4sd`{: .cmd }
140-
</summary>
141-
Display the splash screen for the DS4SD toolkit. <br>
142-
</details>
143-
144-
<details markdown="block" class="cmd-wrap">
145-
<summary markdown="block">
146-
`rxn`{: .cmd }
147-
</summary>
148-
Display the splash screen for the RXN toolkit. <br>
149-
</details>
150-
151-
<details markdown="block" class="cmd-wrap">
152-
<summary markdown="block">
153-
`list toolkits`{: .cmd }
154-
</summary>
155-
List all installed toolkits. <br>
156-
</details>
157-
158-
<details markdown="block" class="cmd-wrap">
159-
<summary markdown="block">
160-
`list all toolkits`{: .cmd }
161-
</summary>
162-
List all available toolkits. <br>
163-
</details>
164-
165-
<details markdown="block" class="cmd-wrap">
166-
<summary markdown="block">
167-
`add toolkit <toolkit_name>`{: .cmd }
168-
</summary>
169-
Install a toolkit. <br>
170-
</details>
171-
172-
<details markdown="block" class="cmd-wrap">
173-
<summary markdown="block">
174-
`remove toolkit <toolkit_name>`{: .cmd }
175-
</summary>
176-
Remove a toolkit from the registry. <br>
177-
178-
<b>Note:</b> This doesn't delete the toolkit code. If the toolkit is added again, a backup of the previous install is created in the toolkit directory at `~/.openad/toolkits`. <br>
179-
</details>
180-
181-
<details markdown="block" class="cmd-wrap">
182-
<summary markdown="block">
183-
`update toolkit <toolkit_name>`{: .cmd }
184-
</summary>
185-
Update a toolkit with the latest version. It is recommended to do this on a regular basis. <br>
186-
</details>
187-
188-
<details markdown="block" class="cmd-wrap">
189-
<summary markdown="block">
190-
`update all toolkits`{: .cmd }
191-
</summary>
192-
Update all installed toolkits with the latest version. Happens automatically whenever OpenAD is updated to a new version. <br>
193-
</details>
194-
195137
<details markdown="block" class="cmd-wrap">
196138
<summary markdown="block">
197139
`set context <toolkit_name> [ reset ]`{: .cmd }
198140
</summary>
199141
Set your context to the chosen toolkit. By setting the context, the selected toolkit functions become available to you. The optional parameter `reset` can be used to reset your login information. <br>
200142
</details>
201143

202-
<details markdown="block" class="cmd-wrap">
203-
<summary markdown="block">
204-
`get context`{: .cmd }
205-
</summary>
206-
Display the currently selected toolkit. <br>
207-
</details>
208-
209-
<details markdown="block" class="cmd-wrap">
210-
<summary markdown="block">
211-
`unset context`{: .cmd }
212-
</summary>
213-
Exit your toolkit context. You will no longer have access to toolkit-specific functions. <br>
214-
</details>
215-
216144
### Runs
217145

218146
<details markdown="block" class="cmd-wrap">

index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ Open Accelerated Discovery (aka OpenAD) is an open-source framework for molecula
3030
The OpenAD client is accessible from our command line interface, via Jupyter Notebook or our API. It provides unified access to a variety of tools and AI models for literature knowledge extraction, forward and retrosynthesis prediction, generative methods and property inference. OpenAD lets you train models on your own data, to then visualize and filter your candidate molecules.
3131

3232
<br>
33+
## Latest Release Notes
34+
OpenAD has remove the RXN and Deep Search toolkits and replaced them with new and more user Friendly plugins !
35+
36+
To add the respective toolkits as Plugins:
37+
38+
- RXN Plugin Install and Usage Instructions
39+
https://github.com/acceleratedscience/openad-plugin-rxn
40+
41+
- DeepSearch (DS4SD) Install and Usage Instructions
42+
https://github.com/acceleratedscience/openad-plugin-ds
3343

3444
### Useful links
3545

plugins.md

Lines changed: 15 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -20,86 +20,28 @@ Plugins are how molecular tools and AI models are made available to the OpenAD c
2020

2121
Creating your own plugins is easy if you have a basic understanding of Python.
2222

23-
<br><br>
24-
25-
## Registration
26-
27-
Before you can interact with the plugins, you'll need to register with each individual plugin.
28-
29-
<details>
30-
<summary>Register with DS4SD (Deep Search)</summary>
31-
<div markdown="block">
32-
33-
1. First, you'll need to generate an API key on the Deep Search website.
34-
35-
- Visit the Deep Search website and create an account:<br>
36-
[deepsearch-experience.res.ibm.com](https://deepsearch-experience.res.ibm.com)<br>
37-
- Once logged in, click the `Toolkit / API` icon in the top right hand corner, then open the HTTP section
38-
- Click the "Generate new API key" button<br>
39-
<br>
40-
<img src="https://raw.githubusercontent.com/acceleratedscience/open-ad-toolkit/main/assets/ds-api-key.png" width="819" />
41-
42-
2. Once inside the OpenAD client, you'll be prompted to authenticate when activating the Deep Search (DS4SD) toolkit. When running `set context ds4sd` :
43-
44-
- **Hostname:** Default: [https://sds.app.accelerate.science](https://sds.app.accelerate.science)
45-
- **Email:** Your email
46-
- **API_key:** The DS4SD API key you obtained following the instructions above.
47-
48-
3. You should get a message saying you successfully logged in.
49-
50-
> **Note:** Your DS4SD auth config file is saved as `~/.openad/deepsearch_api.cred`. If you ever want to reset your DS4SD login information you can run `set context ds4sd reset`, or you can delete this file.<br>
51-
52-
</div>
53-
</details>
54-
55-
<details>
56-
<summary>Register with RXN</summary>
57-
<div markdown="block">
58-
59-
1. First, you'll need to generate an API key on the RXN website.
23+
<br>
6024

61-
- Sign up for an RXN account at [rxn.app.accelerate.science](https://rxn.app.accelerate.science)
62-
- Obtain your API key by clicking the user profile icon in the top right hand corner and select "Account", then select the "My keys" tab.<br>
63-
<br>
64-
<img src="https://raw.githubusercontent.com/acceleratedscience/open-ad-toolkit/main/assets/rxn-api-key.png" width="821" />
25+
### Creating Your Own Plugin
26+
You can create your first plugin in just minutes. This creates the ability for your own projects (or your favorite tools) to access OpenAD's powerful visualisation capabilities and more.
6527

66-
2. When setting the context to RXN using `set context rxn` you'll be prompted to create a new auth configuration file:
67-
68-
- **Hostname:** Default: [https://rxn.app.accelerate.science](https://rxn.app.accelerate.science)<br>
69-
- **API_key:** The RXN API key you obtained following the instructions above.
70-
71-
3. You should get a message saying you successfully logged in.<br>
72-
73-
> **Note:** Your RXN auth config file is saved as `~/.openad/rxn_api.cred`. If you ever want to reset your RXN login information you can run `set context rxn reset`, or you can delete this file.<br>
74-
75-
</div>
76-
</details>
77-
78-
<br><br>
79-
80-
## Adding a Toolkit
81-
82-
First install the toolkit, then set the context to this toolkit.
83-
84-
> <div class='alert-icn-wrap' style='color:#8250df'><svg class="alert-icon" width="16" height="16" viewBox="0 0 16 16" fill="#8250df" xmlns="http://www.w3.org/2000/svg"><path d="M8 1C6.61553 1 5.26216 1.41054 4.11101 2.17971C2.95987 2.94888 2.06266 4.04213 1.53285 5.32122C1.00303 6.6003 0.86441 8.00776 1.13451 9.36563C1.4046 10.7235 2.07129 11.9708 3.05026 12.9497C4.02922 13.9287 5.2765 14.5954 6.63437 14.8655C7.99224 15.1356 9.3997 14.997 10.6788 14.4672C11.9579 13.9373 13.0511 13.0401 13.8203 11.889C14.5895 10.7378 15 9.38447 15 8C15 6.14348 14.2625 4.36301 12.9497 3.05025C11.637 1.7375 9.85652 1 8 1ZM8 14C6.81332 14 5.65328 13.6481 4.66658 12.9888C3.67989 12.3295 2.91085 11.3925 2.45673 10.2961C2.0026 9.19974 1.88378 7.99334 2.11529 6.82946C2.3468 5.66557 2.91825 4.59647 3.75736 3.75736C4.59648 2.91824 5.66558 2.3468 6.82946 2.11529C7.99335 1.88378 9.19975 2.0026 10.2961 2.45672C11.3925 2.91085 12.3295 3.67988 12.9888 4.66658C13.6481 5.65327 14 6.81331 14 8C14 9.5913 13.3679 11.1174 12.2426 12.2426C11.1174 13.3679 9.5913 14 8 14Z"/><path d="M8.5 4H7.5V9.5H8.5V4Z"/><path d="M8 11C7.85167 11 7.70666 11.044 7.58333 11.1264C7.45999 11.2088 7.36386 11.3259 7.30709 11.463C7.25033 11.6 7.23547 11.7508 7.26441 11.8963C7.29335 12.0418 7.36478 12.1754 7.46967 12.2803C7.57456 12.3852 7.7082 12.4567 7.85369 12.4856C7.99917 12.5145 8.14997 12.4997 8.28701 12.4429C8.42406 12.3861 8.54119 12.29 8.6236 12.1667C8.70602 12.0433 8.75 11.8983 8.75 11.75C8.75 11.5511 8.67098 11.3603 8.53033 11.2197C8.38968 11.079 8.19892 11 8 11Z"/></svg> IMPORTANT</div><span style='color: #8250df'>When running commands from Jupyter, prepend them with `%openad`</span>
85-
86-
add toolkit ds4sd
87-
set context ds4sd
28+
We will be publishing a detailed tutorial soon on this page.
8829

8930
<br><br>
9031

91-
## Sample Commands
92-
93-
# DS4SD
94-
display all collections
32+
## Available Plugins
9533

96-
# RXN
97-
list rxn models
34+
Currently there are two publicly available plugins available.
9835

99-
<br><br>
36+
1. **Deep Search**<br>
37+
Find molecules by similarity or substructure, scan patents for molecules and vice versa and search across available Deep Search collections.<br>
38+
More information about this plugin can be found in the [openad-plugin-ds](https://github.com/acceleratedscience/openad-plugin-ds) repo.
10039

101-
## Running Bash Commands (CLI)
40+
pip install git+https://github.com/acceleratedscience/openad-plugin-ds
10241

103-
To run a command in bash mode, prepend it with `openad` and make sure to escape quotes.
42+
<br><br>
43+
1. **RXN**<br>
44+
RXN helps you predict chemical reactions, retrosynthesis pathways and experimental procedures.<br>
45+
More information about this plugin can be found in the [openad-plugin-rxn](https://github.com/acceleratedscience/openad-plugin-rxn) repo.
10446

105-
openad show molecules using file \'base_molecules.sdf\'
47+
pip install git+https://github.com/acceleratedscience/openad-plugin-rxn

0 commit comments

Comments
 (0)