From 46ec6b659287f445e543fc1b4e1075a95ae6780f Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Fri, 5 Jul 2024 09:36:52 +0100 Subject: [PATCH] note about renaming/symlinking --- main_BSREM.py | 4 +++- main_ISTA.py | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/main_BSREM.py b/main_BSREM.py index 3974ba8..482ae1d 100644 --- a/main_BSREM.py +++ b/main_BSREM.py @@ -1,4 +1,6 @@ -"""Main file to modify for submissions. It is used by e.g. example.ipynb and petric.py as follows: +"""Main file to modify for submissions. + +Once renamed or symlinked as `main.py`, it will be used by `petric.py` as follows: >>> from main import Submission, submission_callbacks >>> from petric import data, metrics diff --git a/main_ISTA.py b/main_ISTA.py index 17a577e..e24138f 100644 --- a/main_ISTA.py +++ b/main_ISTA.py @@ -1,4 +1,6 @@ -"""Main file to modify for submissions. It is used by e.g. example.ipynb and petric.py as follows: +"""Main file to modify for submissions. + +Once renamed or symlinked as `main.py`, it will be used by `petric.py` as follows: >>> from main import Submission, submission_callbacks >>> from petric import data, metrics