Experiment.start Returns Records

[MattToast]

Basic implementation of a Record class to keep track of launched jobs. Convert Experiment.start return Records and all other methods to accept records.

[codecov]

Codecov Report

Attention: Patch coverage is 95.45455% with 2 lines in your changes missing coverage. Please review.

Please upload report for BASE (v1.0@879b96e). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
smartsim/launchable/job.py	86.66%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             v1.0     #744   +/-   ##
=======================================
  Coverage        ?   59.04%           
=======================================
  Files           ?      142           
  Lines           ?     9140           
  Branches        ?        0           
=======================================
  Hits            ?     5397           
  Misses          ?     3743           
  Partials        ?        0           

Files with missing lines	Coverage Δ
smartsim/_core/utils/helpers.py	41.66% <ø> (ø)
smartsim/experiment.py	88.53% <100.00%> (ø)
smartsim/launchable/job.py	93.84% <86.66%> (ø)

[amandarichardsonn]

Some small suggestions!

[amandarichardsonn]

Why do you deep copying the Job but not the launch_id here?

[MattToast]

In theory, the launch_id (at least for now), is just a string that we ask the type checker to treat like a different type, and strings are immutable in python, so a "deepcopy of" and a "reference to" a string are functionally equivalent.

There is actually some special logic in copy.deepcopy so that, by default, it will just return the original reference to a string if its encounter without change.

TL;DR I was lazy and didn't want to spell out "deepcopy". More than willing to add it though if we think that LaunchedJobID might become a more substantive type in future!