v1.4.0

What's new

This release comes with an important HTTP performance and robustness upgrade, specifically with how the client makes requests to the Beaker server.

Added 🎉

• Added Beaker.session() context manager for improving performance when calling a series of
  client methods in a row.
• Added timeout parameter to Beaker client initialization methods with a default of 5 (seconds).
  This controls the connect and read timeouts of HTTP requests sent to the Beaker server.

Commits

9ac5677 Merge pull request #122 from allenai/http-perf
bbb1bf7 fix token
8f31e0d fix setup-beaker
9da6bf7 Add timeout parameter
d8dcae2 Use session in sweep example
739869e Add Beaker.session() context manager

v1.3.0

What's new

Added 🎉

• Added Beaker.group.export_experiments() method.

Fixed ✅

• Fixed Job priority validation.

Commits

529018a Add export_experiments method to GroupClient (#116)
c43f83b Fix priority validation

v1.2.0

What's new

Added 🎉

• Added Beaker.dataset.file_info() method.
• Added .workspace (WorkspaceRef) property to Dataset, Image, Group, and Experiment.
  This is just an alias for the .workspace_ref property.

Changed ⚠️

• Beaker.dataset.stream_file() now can also take a FileInfo object as the 2nd argument instead of a file path.
• Digest class is now hashable.

Commits

941dd4c Bump mypy from 0.950 to 0.960 (#112)
79bd8ba pin rich tighter
2fffeb2 Add Beaker.dataset.file_info() method (#113)
cf30caa Add .workspace alias to some data models
4b60ee7 Update README.md

v1.1.0

What's new

Added 🎉

• Added ExperimentSpec.to_file() method.

Commits

49e62a0 Add ExperimentSpec.to_file() method (#110)
451569f Update workspace fixtures (#109)

v1.0.0

What's new

Removed 👋

• Removed deprecated Beaker.experiment.await_all() method.

Commits

5ba96c2 Remove deprecated Beaker.experiment.await_all() method (#107)
a32fcfa use tiny preemptible cluster for testing
0561492 Fix typo
95a049b Document features in README

v0.15.3

What's new

Added 🎉

• Added Digest type and changed type of FileInfo.digest from str to Digest.

Commits

b20a010 Add Digest class (#105)
f46bac1 Update rich requirement from <12.4,>=12.0 to >=12.0,<12.5 (#100)

v0.15.2

What's new

Added 🎉

• Added Beaker.experiment.latest_job() method.
• Added strict: bool argument to Beaker.(experiment|job).(wait_for|as_completed) methods.
• Added description and source_execution fields to Dataset.
• Added description field to Experiment.
• Added description field to Image.
• Added description field to Workspace.

Commits

31ca8a0 Add missing description field (#104)
2553824 Additions to Beaker.experiment and Beaker.job (#103)

v0.15.1

What's new

Added 🎉

• Docker images released with major and major+minor version tags in addition to full version tag.

Commits

ee0b84c fix typo in docs

v0.15.0

What's new

Added 🎉

• Added ExperimentSpec.with_description().
• Added TaskSpec.with_image(), .with_result(), .with_context(), .with_name(), .with_command(), and .with_arguments().

Changed ⚠️

• Renamed delete_results_dataset param to delete_results_datasets in Beaker.experiment.delete().
• Renamed TaskSpec.with_data() to TaskSpec.with_dataset().

Fixed ✅

• Fixed bug with Beaker.experiment.delete() that would lead to a ValueError being raised when the experiment to delete has multiple tasks.

Commits

49d677c Sweep example (#99)
998ea30 Fix bug with Beaker.experiment.delete(), add more mutation methods to experiment / task specs (#97)

v0.14.1

What's new

Changed ⚠️

• Replaced id: str field of ClusterUtilization with cluster: Cluster. id is still available
  as a property for backwards compatibility.

Commits

25676aa Replace ClusterUtilization.id with ClusterUtilization.cluster