Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.0.0 Python client release #1906

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions lib/python/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Release Notes

All dates are formatted dd/mm/yyyy.

## 3.0.0 - <DATE>

### Breaking Changes

- Change minimum supported Python version to 3.9 (was 3.8).
- Remove all `Client` team methods (`post_team`, `get_all_teams`, `get_user_teams`, `get_team` and `patch_team`).
- Remove `kind` param from `Client.get_models`.

### Changes

- Change maximum supported Python version to 3.13 (was 3.11).
- Update package dependencies.
- Add optional `**kwargs` to `PkiAgent` & `TokenAgent`'s `__init__` methods to override `Agent` default params.
- Add optional `organisation` & `state` params to `Client`'s `post_model`, `patch_model` methods.
- Add `Client.model_card_from_template` method.
- Change `Entry.card_from_schema` validation of `self.kind` when `schema_id is None`.
- Implement `Entry.card_from_template` method.
- Add `Experiment.published` property to prevent duplicate publications of a single `Experiment`.
- Propagate optional `organisation` & `state` params addition to `Datacard`'s `__init__` & `create`, `Models`'s
`__init__`, `create` & `from_mlflow`, and `Entry`'s `__init__` & `update` methods.
- Propagate `team_id` param removal from `Datacard`'s `create`, and `Model`'s `create` & `from_mlflow` methods.
- Propagate optional `organisation` & `state` returned keys to `Datacard`'s `from_id`, and `Model`'s `from_id` methods.

---

<!-- prettier-ignore-start -->
> [!NOTE]
> Changelog officially introduced. Any older release notes may be missing/abbreviated.
<!-- prettier-ignore-end -->

---

## 2.5.0 - 17/07/2024

### Changes

- Rewrite experiment_tracking_demo.ipynb and models_and_releases_demo_pytorch.ipynb to improve clarity.
- Remove `kind` param from `Client.get_models`.
- Remove `MinimalSchema` enum.
- Make `AccessRequest.create`'s and `Entry.card_from_schema`'s `schema_id` param required.
- Remove optional `select_by`, and require `run_id` `Experiment.publish` params.
- Remove `Experiment.__select_run` method.

## 2.4.0 - 28/06/2024

### Changes

- Remove `Schema.get_all_schema_ids` method.
- Change `Entry.get_card_latest` to throw a `BailoException` rather than raise a warning.
- Reduce logging to be less noisy.
- Minor tweaks to documentation Notebooks formatting.

## 2.3.4 - 11/06/2024

### Changes

- Rework `Release.version` property and associated methods.
- Change `Entry.get_card_latest` to raise a warning rather than throw a `BailoException`.
- Increase logging.

## 2.3.3 - 11/06/2024

### Changes

- Change `Entry.get_card_latest` to throw a `BailoException` rather than raise a warning.

## 2.3.2 - 06/06/2024

### Changes

- Reduce logging to be less noisy.

## 2.3.1 - 23/05/2024

### Changes

- Rework TokenAgent `__init__` method to not get values from env vars or getpass.

## 2.3.0 - 21/05/2024

## 2.2.1 - 17/05/2024

## 2.2.0 - 08/05/2024
1 change: 1 addition & 0 deletions lib/python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ test = [
Documentation = "https://github.com/gchq/bailo/tree/main#readme"
Source = "https://github.com/gchq/bailo"
Tracker = "https://github.com/gchq/bailo/issues"
Changelog = "https://github.com/gchq/Bailo/blob/main/lib/python/CHANGELOG.md"

[tool.flit.module]
name = "bailo"
Expand Down
4 changes: 2 additions & 2 deletions lib/python/src/bailo/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

import logging

# Package Version 2.5.0
__version__ = "2.5.0"
# Package Version 3.0.0
__version__ = "3.0.0"


from bailo.core.agent import Agent, PkiAgent, TokenAgent
Expand Down
Loading