[UnitaryHack] Implementation of Nelder Mead Optimizer #104

Gopal-Dahale · 2023-06-12T13:34:17Z

Purpose

Implemented the Nelder Mead Optimizer.

Details

The optimizer along with tests. Also added the jupyter notebook used to test the optimizer. I have used 200 epochs instead of 100 as the optimizer required more epochs for convergence. This PR resolves #85.

Results

I ran two tests with adaptive equal to True and False for 200 epochs.

adaptive=False, final output is 0.98555, 0.01445

adaptive=True, final output is 0.96625, 0.03375

dimkart · 2023-06-12T16:19:32Z

@Gopal-Dahale Hi and thanks for this. There are some linting errors, could you fix them?

Gopal-Dahale · 2023-06-12T17:00:00Z

Hi @dimkart, I have formatted the code and ran the two commands locally and both of them now give 0:

flake8 lambeq --max-doc-length=74
flake8 lambeq --count --isolated --select=E9,F63,F7,F82 --show-source --statistics

Gopal-Dahale · 2023-06-12T17:18:49Z

Hi @dimkart, I see type check with mypy has failed. I'll fix it. Meanwhile, is there documentation on how to build and test lambeq locally so that I don't have to rely on GitHub actions until I fix them all locally?

dimkart · 2023-06-12T17:24:30Z

Hi @dimkart, I see type check with mypy has failed. I'll fix it. Meanwhile, is there documentation on how to build and test lambeq locally so that I don't have to rely on GitHub actions until I fix them all locally?

Unfortunately there is no documentation for that, but running pytest and mypy locally should work. Check the github actions (build_test.yml) to see the command lines we use for any special options or exclusion of files.

Gopal-Dahale · 2023-06-12T17:26:21Z

Thanks. I have fixed the mypy issue and now it gives Success: no issues found in 58 source files.

lambeq/training/nelder_mead_optimizer.py

dimkart · 2023-06-12T17:53:30Z

@Gopal-Dahale Thanks, tests are now passing. This look already very good, and tomorrow we'll have a closer look at the code and we'll run the notebook to check performance. If you have already tried to run the notebook you might post here a screenshot of the trainer output for comparison. Keep an eye here for new comments :)

ianyfan

Thanks for your submission. I've had a skim through and it looks good so far, I just have a few comments about things that jumped out at me immediately. I would need more time to look through it in detail.

lambeq/training/nelder_mead_optimizer.py

Thommy257 · 2023-06-13T13:13:08Z

lambeq/training/nelder_mead_optimizer.py

+                            self.fsim[j] = self.func(
+                                diagrams, targets, self.sim[j]
+                            )
+        except Exception:


Also here, it would be better to catch a more specific Exception

I have updated it with a RuntimeError.

- Using a RuntimeError exception in except block - Rename self.func to self.objective_func (descriptive) - Updated tests according to renaming

Thommy257

I've left a couple of comments, but in general it looks really great! Good work :)

lambeq/training/nelder_mead_optimizer.py

Thommy257 · 2023-06-13T13:40:59Z

lambeq/training/nelder_mead_optimizer.py

+                    self.fsim[k] = self.objective_func(diagrams,
+                                                       targets,
+                                                       self.sim[k])
+            except RuntimeError:


I'm wondering why the objective function would triggers this error... Is there a reason for that or do we have a bug?

This handles the case when the objective function does not return scalar values. I have updated the code for the objective function.

If it's just used within this class, I think it would be clearer to define a custom exception and raise/catch since it is more specific

Do you mean something like this?

class CustomError(RuntimeError): pass

Any suggestion for the name?

Maybe smething like LossEvalError? @ianyfan?

lambeq/training/nelder_mead_optimizer.py

- The objective fun is updated. It now checks whether the result is scalar or not and raises error if not which is handled by try except block - Added maxfev hyperparam for maximum function evaluations - Fixed typos and code style - Removed redundant code lines - Update state dict

Gopal-Dahale · 2023-06-13T17:45:09Z

Hi, @Thommy257 @ianyfan can you resolve the conversations?

dimkart · 2023-06-13T17:54:32Z

@Gopal-Dahale Hi, thanks for taking the time to respond to all comments -- the conversations will be resolved tomorrow by Ian and Thomas.

Thommy257 · 2023-06-14T09:32:00Z

Let's remove the notebook as well

lambeq/training/nelder_mead_optimizer.py

tests/training/test_nelder_mead_optimizer.py

ianyfan

Hi, sorry for the late review. Again, this all looks very good, but I've left some comments, mainly about code/docstring style, so you only need to address them if you get the chance to.

lambeq/training/nelder_mead_optimizer.py

ianyfan · 2023-06-14T09:11:23Z

lambeq/training/nelder_mead_optimizer.py

+    heuristic search approach, which means that it can sometimes
+    converge to non-stationary points or suboptimal solutions.
+
+    This implementation is based heavily scipy's optimize.minimize. See


based heavily on SciPy's `optimize.minimize` function.

ianyfan · 2023-06-14T09:11:44Z

lambeq/training/nelder_mead_optimizer.py

+        model: QuantumModel,
+        hyperparams: dict[str, float],
+        loss_fn: Callable[[Any, Any], float],
+        bounds: ArrayLike | None = None,


We don't need the extra comma at the end here

lambeq/training/nelder_mead_optimizer.py

Gopal-Dahale · 2023-06-15T15:55:05Z

Hi @ianyfan, I had updated the code as per your comments. Can you resolve the conversations?

dimkart

Thanks for this, good work! The issue will be assigned to you, however the PR will be merged a little later, after a new (already planned) new release.

Gopal-Dahale added 2 commits June 12, 2023 18:59

Nelder Mead Optimizer implementation

07f2528

Jupyter notebook for testing optimizer

c582401

Gopal-Dahale added 2 commits June 12, 2023 22:20

Fix lint (3.11) issues

63f8cf9

Formatted test

9790c4f

Fix mypy error

52912d2

dimkart reviewed Jun 12, 2023

View reviewed changes

lambeq/training/nelder_mead_optimizer.py Outdated Show resolved Hide resolved

Fix typo in init docstring

eff0e06

ianyfan reviewed Jun 13, 2023

View reviewed changes

lambeq/training/nelder_mead_optimizer.py Outdated Show resolved Hide resolved

lambeq/training/nelder_mead_optimizer.py Outdated Show resolved Hide resolved

Thommy257 reviewed Jun 13, 2023

View reviewed changes

lambeq/training/nelder_mead_optimizer.py Outdated Show resolved Hide resolved

Gopal-Dahale added 2 commits June 13, 2023 17:11

Updated based on reviews

fc0ea8d

Fix doc

26b9b8f

Thommy257 reviewed Jun 13, 2023

View reviewed changes

lambeq/training/nelder_mead_optimizer.py Outdated Show resolved Hide resolved

Thommy257 reviewed Jun 13, 2023

View reviewed changes

Based on the reviews

d5dbb82

- Using a RuntimeError exception in except block - Rename self.func to self.objective_func (descriptive) - Updated tests according to renaming

Thommy257 reviewed Jun 13, 2023

View reviewed changes

Gopal-Dahale added 3 commits June 13, 2023 22:12

Updated tests as per code changes

89499ff

Updated notebook with latest code

b8d01bd

Added references

2e38736

Removed notebook

dee34a6

Thommy257 reviewed Jun 14, 2023

View reviewed changes

lambeq/training/nelder_mead_optimizer.py Outdated Show resolved Hide resolved

Thommy257 reviewed Jun 14, 2023

View reviewed changes

tests/training/test_nelder_mead_optimizer.py Outdated Show resolved Hide resolved

ianyfan reviewed Jun 14, 2023

View reviewed changes

Updated code based on reviews

1c2135a

Gopal-Dahale requested review from ianyfan and Thommy257 June 14, 2023 11:15

dimkart approved these changes Jun 19, 2023

View reviewed changes

Dimitri Kartsaklis added 4 commits June 24, 2023 21:13

Merge remote-tracking branch 'upstream/main' into nelder-mead

d02bf37

Adjust tests to 0.3.2

81e8294

Add references in the docs

8163733

Fix typos

3597e8f

ianyfan closed this in ec2ae88 Jul 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[UnitaryHack] Implementation of Nelder Mead Optimizer #104

[UnitaryHack] Implementation of Nelder Mead Optimizer #104

Gopal-Dahale commented Jun 12, 2023 •

edited

dimkart commented Jun 12, 2023

Gopal-Dahale commented Jun 12, 2023

Gopal-Dahale commented Jun 12, 2023

dimkart commented Jun 12, 2023 •

edited

Gopal-Dahale commented Jun 12, 2023

dimkart commented Jun 12, 2023

ianyfan left a comment

Thommy257 Jun 13, 2023

Gopal-Dahale Jun 13, 2023

Thommy257 left a comment

Thommy257 Jun 13, 2023

Gopal-Dahale Jun 13, 2023 •

edited

ianyfan Jun 14, 2023

Gopal-Dahale Jun 14, 2023 •

edited

Thommy257 Jun 14, 2023

Gopal-Dahale commented Jun 13, 2023

dimkart commented Jun 13, 2023

Thommy257 commented Jun 14, 2023

ianyfan left a comment

ianyfan Jun 14, 2023

ianyfan Jun 14, 2023

Gopal-Dahale commented Jun 15, 2023

dimkart left a comment

[UnitaryHack] Implementation of Nelder Mead Optimizer #104

[UnitaryHack] Implementation of Nelder Mead Optimizer #104

Conversation

Gopal-Dahale commented Jun 12, 2023 • edited

Purpose

Details

Results

dimkart commented Jun 12, 2023

Gopal-Dahale commented Jun 12, 2023

Gopal-Dahale commented Jun 12, 2023

dimkart commented Jun 12, 2023 • edited

Gopal-Dahale commented Jun 12, 2023

dimkart commented Jun 12, 2023

ianyfan left a comment

Choose a reason for hiding this comment

Thommy257 Jun 13, 2023

Choose a reason for hiding this comment

Gopal-Dahale Jun 13, 2023

Choose a reason for hiding this comment

Thommy257 left a comment

Choose a reason for hiding this comment

Thommy257 Jun 13, 2023

Choose a reason for hiding this comment

Gopal-Dahale Jun 13, 2023 • edited

Choose a reason for hiding this comment

ianyfan Jun 14, 2023

Choose a reason for hiding this comment

Gopal-Dahale Jun 14, 2023 • edited

Choose a reason for hiding this comment

Thommy257 Jun 14, 2023

Choose a reason for hiding this comment

Gopal-Dahale commented Jun 13, 2023

dimkart commented Jun 13, 2023

Thommy257 commented Jun 14, 2023

ianyfan left a comment

Choose a reason for hiding this comment

ianyfan Jun 14, 2023

Choose a reason for hiding this comment

ianyfan Jun 14, 2023

Choose a reason for hiding this comment

Gopal-Dahale commented Jun 15, 2023

dimkart left a comment

Choose a reason for hiding this comment

Gopal-Dahale commented Jun 12, 2023 •

edited

dimkart commented Jun 12, 2023 •

edited

Gopal-Dahale Jun 13, 2023 •

edited

Gopal-Dahale Jun 14, 2023 •

edited