Skip to content

Commit 521c3da

Browse files
author
basiekjusz
committed
Add run_search_with_metadata to readme
1 parent 9d65799 commit 521c3da

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,21 @@ search = m1wrapper.run_batch_search(
7373
)
7474
```
7575

76+
### Batch scoring request with compound metadata
77+
`run_search_with_metadata(targets_with_metadata, parameters, detail_level, priority, invalid_target_strategy, starting_materials, name)`
78+
- *targets_with_metadata*: list of target compounds with metadata. Each target compound should be a dictionary object of shape `{ smiles: str, name: str}` where the only required field is `smiles`.
79+
- *parameters* (optional): additional configuration for your batch
80+
scoring request. See [Batch Scoring API](https://github.com/molecule-one/api/blob/master/api-v2.md) for more information.
81+
- *detail_level* (optional): [detail level of the batch request](#batch-scoring-detail-level)
82+
- *priority* (optional): [priority of the batch request](#batch-scoring-priorities)
83+
- *invalid_target_strategy* (optional): if set to `InvalidTargetStrategy.PASS`, targets that cannot be canonized by our SMILES parser won't cause the whole batch request to be rejected. Defaults to `InvalidTargetStrategy.REJECT`.
84+
- *starting_materials* (optional): list of available compounds in SMILES format
85+
- *name* (optional): name of your batch request
86+
87+
```py
88+
run_search_with_metadata(targets_with_metadata=[{name: 'compound1', smiles: a}, {smiles: b}, {name: 'compound3', smiles: c}], priority=Priority.HIGH)
89+
```
90+
7691
### Getting exisiting scoring request by id:
7792
```py
7893
search = m1wrapper.get_batch_search(id)

0 commit comments

Comments
 (0)