Merge pull request #767 from CitrineInformatics/feature/pla-9401-configure-default-design-spaces

[PLA-9401] Configure the default design space.

Author: anoto-moniz

src/citrine/__version__.py

@@ -1 +1 @@
-__version__ = '1.33.3'
+__version__ = '1.34.0'

src/citrine/resources/design_space.py

@@ -64,7 +64,12 @@ def update(self, model: DesignSpace) -> DesignSpace:
         self._validate_write_request(model)
         return AbstractModuleCollection.update(self, model)
 
-    def create_default(self, *, predictor_id: UUID) -> DesignSpace:
+    def create_default(self,
+                       *,
+                       predictor_id: UUID,
+                       include_ingredient_fraction_constraints: bool = False,
+                       include_label_fraction_constraints: bool = False,
+                       include_label_count_constraints: bool = False) -> DesignSpace:
         """[ALPHA] Create a default design space for a predictor.
 
         This method will return an unregistered design space for all inputs
@@ -83,14 +88,32 @@ def create_default(self, *, predictor_id: UUID) -> DesignSpace:
         predictor_id: UUID
             UUID of the predictor used to construct the design space
 
+        include_ingredient_fraction_constraints: bool
+            Whether to include constraints on ingredient fractions based on the training data.
+            Defaults to False.
+
+        include_label_fraction_constraints: bool
+            Whether to include constraints on label fractions based on the training data.
+            Defaults to False.
+
+        include_label_count_constraints: bool
+            Whether to include constraints on labeled ingredient counts based on the training data.
+            Defaults to False.
+
         Returns
         -------
         DesignSpace
             Default design space
 
         """
-        path = f'projects/{self.project_id}/predictors/{predictor_id}/default-design-space'
-        data = self.session.get_resource(path)
+        path = f'projects/{self.project_id}/design-spaces/default'
+        payload = {
+            "predictor_id": predictor_id,
+            "include_ingredient_fraction_constraints": include_ingredient_fraction_constraints,
+            "include_label_fraction_constraints": include_label_fraction_constraints,
+            "include_label_count_constraints": include_label_count_constraints
+        }
+        data = self.session.post_resource(path, json=payload, version="v2")
         if 'instance' in data:
             data['config'] = data.pop('instance')
         return self.build(data)

tests/resources/test_design_space.py

@@ -1,5 +1,5 @@
-from copy import deepcopy
 import uuid
+from copy import deepcopy
 from random import random
 
 import mock
@@ -116,13 +116,77 @@ def test_create_default(valid_product_design_space_data,
 
     session = FakeSession()
     session.set_response(data_with_instance)
+    
+    predictor_id = uuid.uuid4()
+    collection = DesignSpaceCollection(
+        project_id=uuid.uuid4(),
+        session=session
+    )
+
+    expected_call = FakeCall(
+        method='POST',
+        path=f"projects/{collection.project_id}/design-spaces/default",
+        json={
+            "predictor_id": predictor_id,
+            "include_ingredient_fraction_constraints": False,
+            "include_label_fraction_constraints": False,
+            "include_label_count_constraints": False
+        },
+        version="v2"
+    )
+    
+    default_design_space = collection.create_default(predictor_id=predictor_id)
+
+    assert session.num_calls == 1
+    assert session.last_call == expected_call
+    
+    assert default_design_space.dump() == valid_product_design_space.dump()
+
+
+@pytest.mark.parametrize("ingredient_fractions", (True, False))
+@pytest.mark.parametrize("label_fractions", (True, False))
+@pytest.mark.parametrize("label_count", (True, False))
+def test_create_default_with_config(valid_product_design_space_data, valid_product_design_space,
+                                    ingredient_fractions, label_fractions, label_count):
+    # The instance field isn't renamed to config in objects returned from this route
+    # This renames the config key to instance to match the data we get from the API
+    data_with_instance = deepcopy(valid_product_design_space_data)
+    data_with_instance['instance'] = data_with_instance.pop('config')
+
+    session = FakeSession()
+    session.set_response(data_with_instance)
+    
+    predictor_id = uuid.uuid4()
     collection = DesignSpaceCollection(
         project_id=uuid.uuid4(),
         session=session
     )
-    default_design_space = collection.create_default(predictor_id=uuid.uuid4())
+
+    expected_call = FakeCall(
+        method='POST',
+        path=f"projects/{collection.project_id}/design-spaces/default",
+        json={
+            "predictor_id": predictor_id,
+            "include_ingredient_fraction_constraints": ingredient_fractions,
+            "include_label_fraction_constraints": label_fractions,
+            "include_label_count_constraints": label_count
+        },
+        version="v2"
+    )
+    
+    default_design_space = collection.create_default(
+        predictor_id=predictor_id,
+        include_ingredient_fraction_constraints=ingredient_fractions,
+        include_label_fraction_constraints=label_fractions,
+        include_label_count_constraints=label_count
+    )
+
+    assert session.num_calls == 1
+    assert session.last_call == expected_call
+    
     assert default_design_space.dump() == valid_product_design_space.dump()
 
+
 def test_list_design_spaces(valid_formulation_design_space_data, valid_enumerated_design_space_data):
     # Given
     session = FakeSession()