deriva-ml 1.10.1__py3-none-any.whl → 1.11.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
deriva_ml/execution.py CHANGED
@@ -5,45 +5,37 @@ This module defined the Execution class which is used to interact with the state
5
5
  from __future__ import annotations
6
6
 
7
7
  from collections import defaultdict
8
- import csv
9
8
  import json
10
9
  import logging
11
10
  import os
12
11
  import shutil
13
12
  from datetime import datetime
14
13
  from pathlib import Path
15
- import requests
16
- from tempfile import NamedTemporaryFile
17
14
  from typing import Iterable, Any, Optional
15
+
18
16
  from deriva.core import format_exception
19
- from deriva.core.ermrest_model import Table
20
17
  from pydantic import validate_call, ConfigDict
21
18
  import sys
19
+ from deriva.core.hatrac_store import HatracStore
22
20
 
23
- from .deriva_definitions import MLVocab, ExecMetadataVocab
24
- from .deriva_definitions import (
25
- RID,
26
- Status,
27
- FileUploadState,
28
- UploadState,
29
- DerivaMLException,
30
- )
21
+ from .deriva_definitions import ExecMetadataVocab
22
+ from .deriva_definitions import RID, Status, FileUploadState, DerivaMLException, MLVocab
31
23
  from .deriva_ml_base import DerivaML, FeatureRecord
32
24
  from .dataset_aux_classes import DatasetSpec, DatasetVersion, VersionPart
33
25
  from .dataset_bag import DatasetBag
34
26
  from .execution_configuration import ExecutionConfiguration, Workflow
35
27
  from .execution_environment import get_execution_environment
36
28
  from .upload import (
37
- execution_metadata_dir,
38
- execution_asset_dir,
39
29
  execution_root,
40
30
  feature_root,
41
- feature_asset_dir,
31
+ asset_root,
42
32
  feature_value_path,
43
33
  is_feature_dir,
44
- is_feature_asset_dir,
45
34
  table_path,
46
35
  upload_directory,
36
+ normalize_asset_dir,
37
+ asset_file_path,
38
+ asset_type_path,
47
39
  )
48
40
 
49
41
  try:
@@ -60,6 +52,41 @@ except ImportError:
60
52
  return []
61
53
 
62
54
 
55
+ class AssetFilePath(type(Path())):
56
+ """Derived class of Path that also includes information about a downloaded.
57
+
58
+ An AssetFilePath has all the methods associated with a pathlib.Path object. In addition, it defines additional
59
+ attributes associated with a DerviaML asset.
60
+
61
+ Attributes:
62
+ asset_types: A list of the types associated with this asset. From the Asset_Type controlled vocabulary.
63
+ asset_metadata: A dictionary of names and values of any additional columns associated with this asset.
64
+ asset_name: The name of the asset table
65
+ file_name: The name of the file in the local file system that has the asset contents
66
+ asset_rid: The RID of the asset if it has been uploaded into an asset table
67
+ """
68
+
69
+
70
+ def __new__(
71
+ cls,
72
+ asset_path,
73
+ asset_name: str,
74
+ file_name: str,
75
+ asset_metadata: dict[str, Any],
76
+ asset_types: list[str] | str,
77
+ asset_rid: Optional[RID] = None,
78
+ ):
79
+ obj = super().__new__(cls, asset_path)
80
+ obj.asset_types = (
81
+ asset_types if isinstance(asset_types, list) else [asset_types]
82
+ )
83
+ obj.asset_metadata = asset_metadata
84
+ obj.asset_name = asset_name
85
+ obj.file_name = file_name
86
+ obj.asset_rid = asset_rid
87
+ return obj
88
+
89
+
63
90
  class Execution:
64
91
  """The Execution class is used to capture the context of an activity within DerivaML. While these are primarily
65
92
  computational, manual processes can be represented by an execution as well.
@@ -102,13 +129,14 @@ class Execution:
102
129
  """
103
130
 
104
131
  Args:
105
- configuration:
106
- ml_object:
132
+ configuration: Execution configuration object that describes the execution.
133
+ ml_object: The DerivaML instance that created the execution.
107
134
  reload: RID of previously initialized execution object.
108
135
  """
109
136
  self.asset_paths: list[Path] = []
110
137
  self.configuration = configuration
111
138
  self._ml_object = ml_object
139
+ self._model = ml_object.model
112
140
  self._logger = ml_object._logger
113
141
  self.start_time = None
114
142
  self.stop_time = None
@@ -147,9 +175,7 @@ class Execution:
147
175
  )
148
176
 
149
177
  for a in self.configuration.assets:
150
- if not self._ml_object.model.is_asset(
151
- self._ml_object.resolve_rid(a).table.name
152
- ):
178
+ if not self._model.is_asset(self._ml_object.resolve_rid(a).table.name):
153
179
  raise DerivaMLException(
154
180
  "Asset specified in execution configuration is not a asset table"
155
181
  )
@@ -176,15 +202,12 @@ class Execution:
176
202
  self._initialize_execution(reload)
177
203
 
178
204
  def _save_runtime_environment(self):
179
- runtime_env_path = ExecMetadataVocab.runtime_env.value
180
- runtime_env_dir = self.execution_metadata_path(runtime_env_path)
181
- with NamedTemporaryFile(
182
- "w+",
183
- dir=runtime_env_dir,
184
- prefix="environment_snapshot_",
185
- suffix=".txt",
186
- delete=False,
187
- ) as fp:
205
+ runtime_env_path = self.asset_file_path(
206
+ asset_name="Execution_Metadata",
207
+ file_name=f"environment_snapshot_{datetime.now().strftime('%Y%m%d_%H%M%S')}.txt",
208
+ asset_types=ExecMetadataVocab.runtime_env.value,
209
+ )
210
+ with open(runtime_env_path, "w") as fp:
188
211
  json.dump(get_execution_environment(), fp)
189
212
 
190
213
  def _initialize_execution(self, reload: Optional[RID] = None) -> None:
@@ -206,6 +229,7 @@ class Execution:
206
229
  )
207
230
  self.datasets.append(self.download_dataset_bag(dataset))
208
231
  self.dataset_rids.append(dataset.rid)
232
+
209
233
  # Update execution info
210
234
  schema_path = self._ml_object.pathBuilder.schemas[self._ml_object.ml_schema]
211
235
  if self.dataset_rids and not (reload or self._dry_run):
@@ -218,16 +242,29 @@ class Execution:
218
242
 
219
243
  # Download assets....
220
244
  self.update_status(Status.running, "Downloading assets ...")
221
- self.asset_paths = [
222
- self._ml_object.download_asset(asset_rid=a, dest_dir=self._asset_dir())
223
- for a in self.configuration.assets
224
- ]
225
- if self.asset_paths and not (reload or self._dry_run):
226
- self._update_execution_asset_table(self.configuration.assets)
245
+ self.asset_paths = {}
246
+ for asset_rid in self.configuration.assets:
247
+ asset_table = self._ml_object.resolve_rid(asset_rid).table.name
248
+ dest_dir = (
249
+ execution_root(self._ml_object.working_dir, self.execution_rid)
250
+ / "downloaded-assets"
251
+ / asset_table
252
+ )
253
+ dest_dir.mkdir(parents=True, exist_ok=True)
254
+ self.asset_paths.setdefault(asset_table, []).append(
255
+ self.download_asset(
256
+ asset_rid=asset_rid,
257
+ dest_dir=dest_dir,
258
+ update_catalog=not (reload or self._dry_run),
259
+ )
260
+ )
227
261
 
228
262
  # Save configuration details for later upload
229
- exec_config_path = ExecMetadataVocab.execution_config.value
230
- cfile = self.execution_metadata_path(exec_config_path) / "configuration.json"
263
+ cfile = self.asset_file_path(
264
+ asset_name="Execution_Metadata",
265
+ file_name="configuration.json",
266
+ asset_types=ExecMetadataVocab.execution_config.value,
267
+ )
231
268
  with open(cfile, "w", encoding="utf-8") as config_file:
232
269
  json.dump(self.configuration.model_dump(), config_file)
233
270
 
@@ -237,6 +274,42 @@ class Execution:
237
274
  self.start_time = datetime.now()
238
275
  self.update_status(Status.pending, "Initialize status finished.")
239
276
 
277
+ @property
278
+ def _execution_root(self) -> Path:
279
+ """
280
+
281
+ Args:
282
+
283
+ Returns:
284
+ :return:
285
+
286
+ """
287
+ return execution_root(self._working_dir, self.execution_rid)
288
+
289
+ @property
290
+ def _feature_root(self) -> Path:
291
+ """The root path to all execution specific files.
292
+ :return:
293
+
294
+ Args:
295
+
296
+ Returns:
297
+
298
+ """
299
+ return feature_root(self._working_dir, self.execution_rid)
300
+
301
+ @property
302
+ def _asset_root(self) -> Path:
303
+ """The root path to all execution specific files.
304
+ :return:
305
+
306
+ Args:
307
+
308
+ Returns:
309
+
310
+ """
311
+ return asset_root(self._working_dir, self.execution_rid)
312
+
240
313
  @validate_call(config=ConfigDict(arbitrary_types_allowed=True))
241
314
  def download_dataset_bag(self, dataset: DatasetSpec) -> DatasetBag:
242
315
  """Given a RID to a dataset_table, or a MINID to an existing bag, download the bag file, extract it and validate
@@ -276,27 +349,6 @@ class Execution:
276
349
  ]
277
350
  )
278
351
 
279
- def _create_notebook_checkpoint(self):
280
- """Trigger a checkpoint creation using Jupyter's API."""
281
-
282
- server, session = self._ml_object._get_notebook_session()
283
- notebook_name = session["notebook"]["path"]
284
- notebook_url = f"{server['url']}api/contents/{notebook_name}"
285
-
286
- # Get notebook content
287
- response = requests.get(
288
- notebook_url, headers={"Authorization": f"Token {server['token']}"}
289
- )
290
- if response.status_code == 200:
291
- notebook_content = response.json()["content"]
292
- # Execution metadata cannot be in a directory, so map path into filename.
293
- checkpoint_path = (
294
- self.execution_metadata_path(ExecMetadataVocab.runtime_env.value)
295
- / f"{notebook_name.replace('/', '_')}.checkpoint"
296
- )
297
- with open(checkpoint_path, "w", encoding="utf-8") as f:
298
- json.dump(notebook_content, f)
299
-
300
352
  def execution_start(self) -> None:
301
353
  """Start an execution, uploading status to catalog"""
302
354
 
@@ -318,7 +370,7 @@ class Execution:
318
370
  self._ml_object.ml_schema
319
371
  ].Execution.update([{"RID": self.execution_rid, "Duration": duration}])
320
372
 
321
- def _upload_execution_dirs(self) -> dict[str, FileUploadState]:
373
+ def _upload_execution_dirs(self) -> dict[str, list[AssetFilePath]]:
322
374
  """Upload execution assets at _working_dir/Execution_asset.
323
375
 
324
376
  This routine uploads the contents of the
@@ -332,86 +384,142 @@ class Execution:
332
384
  DerivaMLException: If there is an issue uploading the assets.
333
385
  """
334
386
 
335
- def asset_name(p: str) -> str:
336
- return Path(*Path(p).parts[-2:]).as_posix()
337
-
338
387
  try:
339
388
  self.update_status(Status.running, "Uploading execution files...")
340
- results = upload_directory(self._ml_object.model, self._execution_root)
341
- results = {asset_name(k): v for k, v in results.items()}
342
-
343
- execution_assets = [
344
- r.result["RID"]
345
- for r in results.values()
346
- if r.state == UploadState.success and "Execution_Asset_Type" in r.result
347
- ]
348
- execution_metadata = [
349
- r.result["RID"]
350
- for r in results.values()
351
- if r.state == UploadState.success
352
- and "Execution_Metadata_Type" in r.result
353
- ]
354
- self._update_execution_asset_table(execution_assets)
355
- self._update_execution_metadata_table(execution_metadata)
356
-
389
+ results = upload_directory(self._model, self._asset_root)
357
390
  except Exception as e:
358
391
  error = format_exception(e)
359
392
  self.update_status(Status.failed, error)
360
393
  raise DerivaMLException(f"Fail to upload execution_assets. Error: {error}")
361
394
 
395
+ asset_map = {}
396
+ for path, status in results.items():
397
+ asset_table, file_name = normalize_asset_dir(path)
398
+
399
+ asset_map.setdefault(asset_table, []).append(
400
+ AssetFilePath(
401
+ asset_path=path,
402
+ asset_name=asset_table,
403
+ file_name=file_name,
404
+ asset_metadata={
405
+ k: v
406
+ for k, v in status.result.items()
407
+ if k in self._model.asset_metadata(asset_table.split("/")[1])
408
+ },
409
+ asset_types=[],
410
+ asset_rid=status.result["RID"],
411
+ )
412
+ )
413
+
414
+ self._update_asset_execution_table(asset_map)
362
415
  self.update_status(Status.running, "Updating features...")
363
416
 
364
- feature_assets = defaultdict(dict)
365
-
366
- def traverse_bottom_up(directory: Path):
367
- """Traverses the directory tree in a bottom-up order.
368
-
369
- Args:
370
- directory: Path:
371
-
372
- Returns:
373
-
374
- """
375
- entries = list(directory.iterdir())
376
- for entry in entries:
377
- if entry.is_dir():
378
- yield from traverse_bottom_up(entry)
379
- yield directory
380
-
381
- for p in traverse_bottom_up(self._feature_root):
382
- if m := is_feature_asset_dir(p):
383
- try:
384
- self.update_status(
385
- Status.running, f"Uploading feature {m['feature_name']}..."
386
- )
387
- feature_assets[m["target_table"], m["feature_name"]] = (
388
- self._ml_object.upload_assets(p)
389
- )
390
- results |= feature_assets[m["target_table"], m["feature_name"]]
391
- except Exception as e:
392
- error = format_exception(e)
393
- self.update_status(Status.failed, error)
394
- raise DerivaMLException(
395
- f"Fail to upload execution metadata. Error: {error}"
396
- )
397
- elif m := is_feature_dir(p):
398
- files = [f for f in p.iterdir() if f.is_file()]
399
- if files:
400
- self._update_feature_table(
401
- target_table=m["target_table"],
402
- feature_name=m["feature_name"],
403
- feature_file=files[0],
404
- uploaded_files=feature_assets[
405
- m["target_table"], m["feature_name"]
406
- ],
407
- )
417
+ for p in self._feature_root.glob("**/*.jsonl"):
418
+ m = is_feature_dir(p.parent)
419
+ self._update_feature_table(
420
+ target_table=m["target_table"],
421
+ feature_name=m["feature_name"],
422
+ feature_file=p,
423
+ uploaded_files=asset_map,
424
+ )
408
425
 
409
426
  self.update_status(Status.running, "Upload assets complete")
410
- return results
427
+ return asset_map
428
+
429
+ @validate_call(config=ConfigDict(arbitrary_types_allowed=True))
430
+ def download_asset(
431
+ self, asset_rid: RID, dest_dir: Path, update_catalog=True
432
+ ) -> AssetFilePath:
433
+ """Download an asset from a URL and place it in a local directory.
434
+
435
+ Args:
436
+ asset_rid: URL of the asset.
437
+ dest_dir: Destination directory for the asset.
438
+ update_catalog: Whether to update the catalog execution information after downloading.
439
+
440
+ Returns:
441
+ A tuple with the name of the asset table and a Path object to the downloaded asset.
442
+ """
443
+
444
+ asset_table = self._ml_object.resolve_rid(asset_rid).table
445
+ if not self._model.is_asset(asset_table):
446
+ raise DerivaMLException(f"RID {asset_rid} is not for an asset table.")
447
+
448
+ asset_record = self._ml_object.retrieve_rid(asset_rid)
449
+ asset_metadata = {
450
+ k: v
451
+ for k, v in asset_record.items()
452
+ if k in self._model.asset_metadata(asset_table)
453
+ }
454
+ asset_url = asset_record["URL"]
455
+ asset_filename = dest_dir / asset_record["Filename"]
456
+ hs = HatracStore("https", self._ml_object.host_name, self._ml_object.credential)
457
+ hs.get_obj(path=asset_url, destfilename=asset_filename.as_posix())
458
+
459
+ asset_type_table = self._model.find_association(asset_table, MLVocab.asset_type)
460
+ type_path = self._ml_object.pathBuilder.schemas[
461
+ asset_type_table.schema.name
462
+ ].tables[asset_type_table.name]
463
+ asset_types = [
464
+ asset_type[MLVocab.asset_type.value]
465
+ for asset_type in type_path.filter(
466
+ type_path.columns[asset_table.name] == asset_rid
467
+ )
468
+ .attributes(type_path.Asset_Type)
469
+ .fetch()
470
+ ]
471
+
472
+ asset_path = AssetFilePath(
473
+ file_name=asset_filename,
474
+ asset_rid=asset_rid,
475
+ asset_path=asset_filename,
476
+ asset_metadata=asset_metadata,
477
+ asset_name=asset_table.name,
478
+ asset_types=asset_types,
479
+ )
480
+
481
+ if update_catalog:
482
+ self._update_asset_execution_table(
483
+ {f"{asset_table.schema.name}/{asset_table.name}": [asset_path]},
484
+ asset_role="Input",
485
+ )
486
+ return asset_path
487
+
488
+ @validate_call(config=ConfigDict(arbitrary_types_allowed=True))
489
+ def upload_assets(
490
+ self,
491
+ assets_dir: str | Path,
492
+ ) -> dict[Any, FileUploadState] | None:
493
+ """Upload assets from a directory.
494
+
495
+ This routine assumes that the current upload specification includes a configuration for the specified directory.
496
+ Every asset in the specified directory is uploaded
497
+
498
+ Args:
499
+ assets_dir: Directory containing the assets to upload.
500
+
501
+ Returns:
502
+ Results of the upload operation.
503
+
504
+ Raises:
505
+ DerivaMLException: If there is an issue uploading the assets.
506
+ """
507
+
508
+ def path_to_asset(path: str) -> str:
509
+ """Pull the asset name out of a path to that asset in the filesystem"""
510
+ components = path.split("/")
511
+ return components[
512
+ components.index("asset") + 2
513
+ ] # Look for asset in the path to find the name
514
+
515
+ if not self._model.is_asset(Path(assets_dir).name):
516
+ raise DerivaMLException("Directory does not have name of an asset table.")
517
+ results = upload_directory(self._model, assets_dir)
518
+ return {path_to_asset(p): r for p, r in results.items()}
411
519
 
412
520
  def upload_execution_outputs(
413
521
  self, clean_folder: bool = True
414
- ) -> dict[str, FileUploadState]:
522
+ ) -> dict[str, AssetFilePath]:
415
523
  """Upload all the assets and metadata associated with the current execution.
416
524
 
417
525
  This will include any new assets, features, or table values.
@@ -437,19 +545,6 @@ class Execution:
437
545
  self.update_status(Status.failed, error)
438
546
  raise e
439
547
 
440
- def _asset_dir(self) -> Path:
441
- """
442
-
443
- Args:
444
-
445
- Returns:
446
- :return: PathLib path object to model directory.
447
-
448
- """
449
- path = self._working_dir / self.execution_rid / "asset"
450
- path.mkdir(parents=True, exist_ok=True)
451
- return path
452
-
453
548
  def _clean_folder_contents(self, folder_path: Path):
454
549
  """
455
550
 
@@ -472,7 +567,7 @@ class Execution:
472
567
  target_table: str,
473
568
  feature_name: str,
474
569
  feature_file: str | Path,
475
- uploaded_files: dict[str, FileUploadState],
570
+ uploaded_files: dict[str, list[AssetFilePath]],
476
571
  ) -> None:
477
572
  """
478
573
 
@@ -480,121 +575,130 @@ class Execution:
480
575
  target_table: str:
481
576
  feature_name: str:
482
577
  feature_file: str | Path:
483
- uploaded_files: dict[str: FileUploadState]:
578
+ uploaded_files: Dictionary whose key ia an asset name, file-name pair, and whose value is a filename, RID of that asset.
484
579
  """
485
580
 
581
+ # Get the column names of all the Feature columns that should be the RID of an asset
582
+ asset_columns = [
583
+ c.name
584
+ for c in self._ml_object.feature_record_class(
585
+ target_table, feature_name
586
+ ).feature.asset_columns
587
+ ]
588
+
589
+ # Get the names of the columns in the feature that are assets.
486
590
  asset_columns = [
487
591
  c.name
488
592
  for c in self._ml_object.feature_record_class(
489
593
  target_table, feature_name
490
594
  ).feature.asset_columns
491
595
  ]
596
+
492
597
  feature_table = self._ml_object.feature_record_class(
493
598
  target_table, feature_name
494
599
  ).feature.feature_table.name
600
+ asset_map = {
601
+ (asset_table, asset.file_name): asset.asset_rid
602
+ for asset_table, assets in uploaded_files.items()
603
+ for asset in assets
604
+ }
495
605
 
496
606
  def map_path(e):
497
- """
498
-
499
- Args:
500
- e:
501
-
502
- Returns:
503
-
504
- """
505
- # Go through the asset columns and replace the file name with the RID for the uploaded file.
607
+ """Go through the asset columns and replace the file name with the RID for the uploaded file."""
506
608
  for c in asset_columns:
507
- e[c] = asset_map[e[c]]
609
+ e[c] = asset_map[normalize_asset_dir(e[c])]
508
610
  return e
509
611
 
510
- # Create a map between a file name that appeared in the file to the RID of the uploaded file.
511
- asset_map = {
512
- file: asset.result["RID"]
513
- for file, asset in uploaded_files.items()
514
- if asset.state == UploadState.success and asset.result
515
- }
612
+ # Load the JSON file that has the set of records that contain the feature values.
516
613
  with open(feature_file, "r") as feature_values:
517
- entities = [map_path(e) for e in csv.DictReader(feature_values)]
518
- self._ml_object.domain_path.tables[feature_table].insert(entities)
519
-
520
- def _update_execution_metadata_table(self, assets: list[RID]) -> None:
521
- """Upload execution metadata at _working_dir/Execution_metadata."""
522
- ml_schema_path = self._ml_object.pathBuilder.schemas[self._ml_object.ml_schema]
523
- entities = [
524
- {"Execution_Metadata": metadata_rid, "Execution": self.execution_rid}
525
- for metadata_rid in assets
526
- ]
527
- ml_schema_path.Execution_Metadata_Execution.insert(entities)
528
-
529
- def _update_execution_asset_table(self, assets: list[RID]) -> None:
530
- """Assets associated with an execution must be linked to an execution entity after they are uploaded into
531
- the catalog. This routine takes a list of uploaded assets and makes that association.
532
-
533
- Args:
534
- assets: list of RIDS for execution assets.:
535
- """
536
- ml_schema_path = self._ml_object.pathBuilder.schemas[self._ml_object.ml_schema]
537
- entities = [
538
- {"Execution_Asset": asset_rid, "Execution": self.execution_rid}
539
- for asset_rid in assets
540
- ]
541
- ml_schema_path.Execution_Asset_Execution.insert(entities)
542
-
543
- @property
544
- def _execution_metadata_dir(self) -> Path:
545
- """
546
-
547
- Args:
548
-
549
- Returns:
550
- to the catalog by the execution_upload method in an execution object.
551
-
552
- :return:
553
-
554
- """
555
- return execution_metadata_dir(
556
- self._working_dir, exec_rid=self.execution_rid, metadata_type=""
614
+ entities = [json.loads(line.strip()) for line in feature_values]
615
+ # Update the asset columns in the feature and add to the catalog.
616
+ self._ml_object.domain_path.tables[feature_table].insert(
617
+ [map_path(e) for e in entities]
557
618
  )
558
619
 
559
- def execution_metadata_path(self, metadata_type: str) -> Path:
560
- """Return a pathlib Path to the directory in which to place files of type metadata_type.
561
-
562
- These files are uploaded to the catalog as part of the execution of the upload_execution method in DerivaML.
563
-
564
- Args:
565
- metadata_type: Type of metadata to be uploaded. Must be a term in Metadata_Type controlled vocabulary.
566
-
567
- Returns:
568
- Path to the directory in which to place files of type metadata_type.
569
- """
570
- self._ml_object.lookup_term(
571
- MLVocab.execution_metadata_type, metadata_type
572
- ) # Make sure metadata type exists.
573
- return execution_metadata_dir(
574
- self._working_dir, exec_rid=self.execution_rid, metadata_type=metadata_type
575
- )
576
-
577
- @property
578
- def _execution_asset_dir(self) -> Path:
579
- """
620
+ def _update_asset_execution_table(
621
+ self,
622
+ uploaded_assets: dict[str, list[AssetFilePath]],
623
+ asset_role: str = "Output",
624
+ ):
625
+ """Add entry to association table connecting an asset to an execution RID
580
626
 
581
627
  Args:
628
+ uploaded_assets: Dictionary whose key is the name of an asset table, and whose value is a list of RIDs for
629
+ newly added assets to that table.
630
+ asset_role: A term or list of terms from the Asset_Role vocabulary.
631
+ """
632
+ # Make sure the asset role is in the controlled vocabulary table.
633
+ self._ml_object.lookup_term(MLVocab.asset_role, asset_role)
634
+
635
+ pb = self._ml_object.pathBuilder
636
+ for asset_table, asset_list in uploaded_assets.items():
637
+ asset_table_name = asset_table.split("/")[
638
+ 1
639
+ ] # Peel off the schema from the asset table
640
+ asset_exe = self._model.find_association(asset_table_name, "Execution")
641
+ asset_exe_path = pb.schemas[asset_exe.schema.name].tables[asset_exe.name]
642
+ asset_exe_path.insert(
643
+ [
644
+ {
645
+ asset_table_name: asset_path.asset_rid,
646
+ "Execution": self.execution_rid,
647
+ "Asset_Role": asset_role,
648
+ }
649
+ for asset_path in asset_list
650
+ ]
651
+ )
582
652
 
583
- Returns:
584
- :return:
585
-
586
- """
587
- return execution_asset_dir(
588
- self._working_dir, exec_rid=self.execution_rid, asset_type=""
589
- )
653
+ # Now add in the type names via the asset_asset_type association table.
654
+ # Get the list of types for each file in the asset.
655
+ if asset_role == "Input":
656
+ return
657
+ asset_type_map = {}
658
+ with open(
659
+ asset_type_path(
660
+ self._working_dir,
661
+ self.execution_rid,
662
+ self._model.name_to_table(asset_table_name),
663
+ ),
664
+ "r",
665
+ ) as f:
666
+ for line in f:
667
+ asset_type_map.update(json.loads(line.strip()))
668
+ for asset_path in asset_list:
669
+ asset_path.asset_types = asset_type_map[asset_path.file_name]
670
+
671
+ asset_asset_type = self._model.find_association(
672
+ asset_table_name, "Asset_Type"
673
+ )
674
+ type_path = pb.schemas[asset_asset_type.schema.name].tables[
675
+ asset_asset_type.name
676
+ ]
677
+ type_path.insert(
678
+ [
679
+ {asset_table_name: asset.asset_rid, "Asset_Type": t}
680
+ for asset in asset_list
681
+ for t in asset_type_map[asset.file_name]
682
+ ]
683
+ )
590
684
 
591
- def execution_asset_path(self, asset_type: str) -> Path:
685
+ @validate_call(config=ConfigDict(arbitrary_types_allowed=True))
686
+ def asset_file_path(
687
+ self,
688
+ asset_name: str,
689
+ file_name: str,
690
+ asset_types: Optional[list[str] | str] = None,
691
+ **kwargs,
692
+ ) -> AssetFilePath:
592
693
  """Return a pathlib Path to the directory in which to place files for the specified execution_asset type.
593
694
 
594
695
  These files are uploaded as part of the upload_execution method in DerivaML class.
595
696
 
596
697
  Args:
597
- asset_type: Type of asset to be uploaded. Must be a term in Asset_Type controlled vocabulary.
698
+ asset_name: Type of asset to be uploaded. Must be a term in Asset_Type controlled vocabulary.
699
+ asset_types: Type of asset to be uploaded. Defaults to name of the asset.
700
+ file_name: Name of file to be uploaded.
701
+ **kwargs: Any additional metadata values that may be part of the asset table.
598
702
 
599
703
  Returns:
600
704
  Path in which to place asset files.
@@ -602,73 +706,39 @@ class Execution:
602
706
  Raises:
603
707
  DerivaException: If the asset type is not defined.
604
708
  """
605
- self._ml_object.lookup_term(MLVocab.execution_asset_type, asset_type)
709
+ if not self._model.is_asset(asset_name):
710
+ DerivaMLException(f"Table {asset_name} is not an asset")
606
711
 
607
- return execution_asset_dir(
608
- self._working_dir, exec_rid=self.execution_rid, asset_type=asset_type
609
- )
712
+ asset_table = self._model.name_to_table(asset_name)
610
713
 
611
- @property
612
- def _execution_root(self) -> Path:
613
- """
714
+ asset_types = asset_types or kwargs.get("Asset_Type", None) or asset_name
715
+ asset_types = [asset_types] if isinstance(asset_types, str) else asset_types
716
+ for t in asset_types:
717
+ self._ml_object.lookup_term(MLVocab.asset_type, t)
614
718
 
615
- Args:
616
-
617
- Returns:
618
- :return:
619
-
620
- """
621
- return execution_root(self._working_dir, self.execution_rid)
622
-
623
- @property
624
- def _feature_root(self) -> Path:
625
- """The root path to all execution specific files.
626
- :return:
627
-
628
- Args:
629
-
630
- Returns:
631
-
632
- """
633
- return feature_root(self._working_dir, self.execution_rid)
634
-
635
- def feature_paths(
636
- self, table: Table | str, feature_name: str
637
- ) -> tuple[Path, dict[str, Path]]:
638
- """Return the file path of where to place feature values, and assets for the named feature and table.
639
-
640
- A side effect of calling this routine is that the directories in which to place the feature values and assets
641
- will be created
642
-
643
- Args:
644
- table: The table with which the feature is associated.
645
- feature_name: Name of the feature
646
-
647
- Returns:
648
- A tuple whose first element is the path for the feature values and whose second element is a dictionary
649
- of associated asset table names and corresponding paths.
650
- """
651
- feature = self._ml_object.lookup_feature(table, feature_name)
652
-
653
- tpath = feature_value_path(
719
+ asset_path = asset_file_path(
654
720
  self._working_dir,
655
- schema=self._ml_object.domain_schema,
656
- target_table=feature.target_table.name,
657
- feature_name=feature_name,
658
- exec_rid=self.execution_rid,
721
+ self.execution_rid,
722
+ self._model.name_to_table(asset_name),
723
+ file_name,
724
+ metadata=kwargs,
725
+ )
726
+
727
+ # Persist the asset types into a file
728
+ with open(
729
+ asset_type_path(self._working_dir, self.execution_rid, asset_table),
730
+ "a",
731
+ encoding="utf-8",
732
+ ) as f:
733
+ f.write(json.dumps({file_name: asset_types}) + "\n")
734
+
735
+ return AssetFilePath(
736
+ asset_path=asset_path,
737
+ asset_name=asset_name,
738
+ file_name=file_name,
739
+ asset_metadata=kwargs,
740
+ asset_types=asset_types,
659
741
  )
660
- asset_paths = {
661
- asset_table.name: feature_asset_dir(
662
- self._working_dir,
663
- exec_rid=self.execution_rid,
664
- schema=self._ml_object.domain_schema,
665
- target_table=feature.target_table.name,
666
- feature_name=feature_name,
667
- asset_table=asset_table.name,
668
- )
669
- for asset_table in feature.asset_columns
670
- }
671
- return tpath, asset_paths
672
742
 
673
743
  def table_path(self, table: str) -> Path:
674
744
  """Return a local file path to a CSV to add values to a table on upload.
@@ -679,10 +749,7 @@ class Execution:
679
749
  Returns:
680
750
  Pathlib path to the file in which to place table values.
681
751
  """
682
- if (
683
- table
684
- not in self._ml_object.model.schemas[self._ml_object.domain_schema].tables
685
- ):
752
+ if table not in self._model.schemas[self._ml_object.domain_schema].tables:
686
753
  raise DerivaMLException(
687
754
  "Table '{}' not found in domain schema".format(table)
688
755
  )
@@ -696,7 +763,7 @@ class Execution:
696
763
  return self
697
764
 
698
765
  @validate_call
699
- def write_feature_file(self, features: Iterable[FeatureRecord]) -> None:
766
+ def add_features(self, features: Iterable[FeatureRecord]) -> None:
700
767
  """Given a collection of Feature records, write out a CSV file in the appropriate assets directory so that this
701
768
  feature gets uploaded when the execution is complete.
702
769
 
@@ -704,22 +771,28 @@ class Execution:
704
771
  features: Iterable of Feature records to write.
705
772
  """
706
773
 
707
- feature_iter = iter(features)
708
- first_row = next(feature_iter)
774
+ # Make sure feature list is homogeneous:
775
+ sorted_features = defaultdict(list)
776
+ for f in features:
777
+ sorted_features[type(f)].append(f)
778
+ for fs in sorted_features.values():
779
+ self._add_features(fs)
780
+
781
+ def _add_features(self, features: list[FeatureRecord]) -> None:
782
+ # Update feature records to include current execution_rid
783
+ first_row = features[0]
709
784
  feature = first_row.feature
710
- csv_path, _ = self.feature_paths(
711
- feature.target_table.name, feature.feature_name
785
+ json_path = feature_value_path(
786
+ self._working_dir,
787
+ schema=self._ml_object.domain_schema,
788
+ target_table=feature.target_table.name,
789
+ feature_name=feature.feature_name,
790
+ exec_rid=self.execution_rid,
712
791
  )
713
-
714
- fieldnames = {"Execution", "Feature_Name", feature.target_table.name}
715
- fieldnames |= {f.name for f in feature.feature_columns}
716
-
717
- with open(csv_path, "w") as f:
718
- writer = csv.DictWriter(f, fieldnames=fieldnames)
719
- writer.writeheader()
720
- writer.writerow(first_row.model_dump())
721
- for feature in feature_iter:
722
- writer.writerow(feature.model_dump())
792
+ with open(json_path, "a", encoding="utf-8") as file:
793
+ for feature in features:
794
+ feature.Execution = self.execution_rid
795
+ file.write(json.dumps(feature.model_dump(mode="json")) + "\n")
723
796
 
724
797
  @validate_call
725
798
  def create_dataset(self, dataset_types: str | list[str], description: str) -> RID:
@@ -748,9 +821,13 @@ class Execution:
748
821
  Add new elements to an existing dataset. In addition to adding new members, the minor version number of the
749
822
  dataset is incremented and the description, if provide is applied to that new version.
750
823
 
824
+ The RIDs in the list to not have to be all from the same table, but they must be from a table that has
825
+ been configured to be a dataset element type.
826
+
751
827
  Args:
752
828
  dataset_rid: RID of dataset_table to extend or None if new dataset_table is to be created.
753
- members: List of RIDs of members to add to the dataset_table.
829
+ members: List of RIDs of members to add to the dataset_table. RID must be to a table type that is a
830
+ dataset element type (see DerivaML.add_dataset_element_type).
754
831
  validate: Check rid_list to make sure elements are not already in the dataset_table.
755
832
  description: Markdown description of the updated dataset.
756
833
  """