Skip to content

feat: add optimization field to optimization for backwards compatibil… #310

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.

Sign up for GitHub

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

Open
jeremiespiesser-extrality wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add optimization field to optimization for backwards compatibil… #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 1 addition & 4 deletions doc/source/examples/01_pysimai_ex/04-non_parametric_optimization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@
import os

import ansys.simai.core as asc
from ansys.simai.core.data.optimizations import Optimization
from ansys.simai.core.data.predictions import Prediction

ORGANIZATION_NAME = "<your_organization_name>"
Expand Down Expand Up @@ -213,9 +212,7 @@
# Get the optimization ID for either a server-side or legacy optimization,
# and print the generated geometries and objective values:

optimization_id = (
optimization.id if isinstance(optimization, Optimization) else optimization.optimization.id
)
optimization_id = optimization.optimization.id

@tmpbeing tmpbeing Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was the previous method broken ? I don't think we should recommend users to use that approach when we probably don't want to keep it long term.


print(f"Optimization ID: {optimization_id}")
print(f"Generated geometries: {[geo.name for geo in optimization.list_geometries()]}")
Expand Down
6 changes: 6 additions & 0 deletions src/ansys/simai/core/data/optimizations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from typing import Any, Dict, List, Literal, Optional, Union

from tqdm import tqdm
from typing_extensions import Self
from wakepy import keep

from ansys.simai.core.data.base import ComputableDataModel, Directory
Expand Down Expand Up @@ -73,6 +74,11 @@ def __init__(self, *args, **kwargs):
self._geometries = None
self._objectives = None

@property
def optimization(self) -> Self:
"""Returns self. Present for backwards compatibility with LegacyOptimizationResult."""

@tmpbeing tmpbeing Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add a deprecation warning saying this will be removed when the legacy client-side optimization will be removed.

return self

@property
def iteration_results(self) -> Optional[List[Dict]]:
"""List of iteration results generated by the optimization."""
Expand Down
1 change: 1 addition & 0 deletions tests/test_optimizations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,7 @@ def test_run_non_parametric_optimization(simai_client, geometry_factory, model_f

assert isinstance(result, Optimization)
assert not result.is_ready
assert result.optimization.id == "theid"

iteration_results = [
{
Expand Down
Loading