Skip to content

Commit 003aa18

Browse files
CI: Automated documentation build
1 parent 5327b2b commit 003aa18

2 files changed

Lines changed: 50 additions & 17 deletions

File tree

docs/foundry.foundry.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -821,7 +821,7 @@ Returns the set of fields that have been explicitly set on this model instance.
821821

822822
---
823823

824-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/foundry.py#L484"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
824+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/foundry.py#L482"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
825825

826826
### <kbd>method</kbd> `check_status`
827827

@@ -879,7 +879,7 @@ Converts the result of a forge query to a FoundryDatset object
879879

880880
---
881881

882-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/foundry.py#L378"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
882+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/foundry.py#L376"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
883883

884884
### <kbd>method</kbd> `filter_datasets_by_query`
885885

@@ -1006,7 +1006,7 @@ List available Foundry datasets
10061006

10071007
---
10081008

1009-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/foundry.py#L415"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
1009+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/foundry.py#L413"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
10101010

10111011
### <kbd>method</kbd> `publish_dataset`
10121012

@@ -1091,7 +1091,7 @@ This method searches for available Foundry datasets based on the provided query
10911091

10921092
---
10931093

1094-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/foundry.py#L395"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
1094+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/foundry.py#L393"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
10951095

10961096
### <kbd>method</kbd> `search_results_to_dataframe`
10971097

docs/foundry.mdf_client.md

Lines changed: 46 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ Also includes staging upload functionality for publishing local data to MDF with
1414
- **STAGING_ENDPOINT_ID**
1515
- **STAGING_BASE_PATH**
1616
- **TRANSFER_API_BASE**
17+
- **MDF_INDEX_ID**
18+
- **MDF_TEST_INDEX_ID**
1719

1820

1921
---
2022

21-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L22"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
23+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L26"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
2224

2325
## <kbd>class</kbd> `StagingUploader`
2426
Handles uploading files to MDF staging endpoint.
@@ -27,7 +29,7 @@ This allows users to publish local data to MDF without needing Globus Connect Pe
2729

2830
Usage: uploader = StagingUploader(transfer_token) unique_id, remote_dir = uploader.create_staging_directory() uploader.upload_file(Path("data.csv"), remote_dir) # Then use globus://{STAGING_ENDPOINT_ID}{remote_dir}/ as data source
2931

30-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L36"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
32+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L40"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
3133

3234
### <kbd>method</kbd> `__init__`
3335

@@ -49,7 +51,7 @@ Initialize uploader with Globus tokens.
4951

5052
---
5153

52-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L74"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
54+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L78"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
5355

5456
### <kbd>method</kbd> `create_staging_directory`
5557

@@ -66,7 +68,7 @@ Create a unique directory on the staging endpoint.
6668

6769
---
6870

69-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L162"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
71+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L166"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
7072

7173
### <kbd>method</kbd> `get_globus_url`
7274

@@ -91,7 +93,7 @@ This is the format expected by MDF Connect for data sources.
9193

9294
---
9395

94-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L133"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
96+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L137"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
9597

9698
### <kbd>method</kbd> `upload_directory`
9799

@@ -120,7 +122,7 @@ Upload all files from a local directory.
120122

121123
---
122124

123-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L100"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
125+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L104"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
124126

125127
### <kbd>method</kbd> `upload_file`
126128

@@ -150,12 +152,12 @@ Upload a single file to the staging endpoint via HTTPS.
150152

151153
---
152154

153-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L178"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
155+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L182"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
154156

155157
## <kbd>class</kbd> `MDFClient`
156158
Minimal MDF client for dataset search and download.
157159

158-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L181"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
160+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L185"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
159161

160162
### <kbd>method</kbd> `__init__`
161163

@@ -177,7 +179,7 @@ Initialize the MDF client.
177179

178180
---
179181

180-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L255"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
182+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L307"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
181183

182184
### <kbd>method</kbd> `globus_download`
183185

@@ -195,7 +197,7 @@ Download data using Globus Transfer.
195197

196198
---
197199

198-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L210"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
200+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L247"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
199201

200202
### <kbd>method</kbd> `match_dois`
201203

@@ -207,7 +209,7 @@ Filter by DOI.
207209

208210
---
209211

210-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L205"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
212+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L226"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
211213

212214
### <kbd>method</kbd> `match_organizations`
213215

@@ -219,7 +221,7 @@ Filter by organization.
219221

220222
---
221223

222-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L200"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
224+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L221"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
223225

224226
### <kbd>method</kbd> `match_resource_types`
225227

@@ -231,7 +233,25 @@ Filter by resource type.
231233

232234
---
233235

234-
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L215"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
236+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L231"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
237+
238+
### <kbd>method</kbd> `match_source_names`
239+
240+
```python
241+
match_source_names(source_name: str) → MDFClient
242+
```
243+
244+
Filter by source name or source ID.
245+
246+
247+
248+
**Args:**
249+
250+
- <b>`source_name`</b>: The source_name or source_id of the dataset. If a source_id is provided (e.g., 'dataset_v1.1'), the version suffix is stripped automatically.
251+
252+
---
253+
254+
<a href="https://github.com/MLMI2-CSSI/foundry/tree/main/foundry/mdf_client.py#L252"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
235255

236256
### <kbd>method</kbd> `search`
237257

@@ -248,6 +268,19 @@ Search for datasets.
248268

249269

250270

271+
**Args:**
272+
273+
- <b>`q`</b>: Free-text search query
274+
- <b>`advanced`</b>: Force advanced query mode. Automatically enabled when field-specific filters (DOI, source_name) are used.
275+
- <b>`limit`</b>: Maximum number of results to return
276+
277+
278+
279+
**Returns:**
280+
List of dataset metadata dictionaries
281+
282+
283+
251284

252285
---
253286

0 commit comments

Comments
 (0)