braindecode 1.5.0.dev1007__tar.gz → 1.5.0.dev1009__tar.gz

{braindecode-1.5.0.dev1007/braindecode.egg-info → braindecode-1.5.0.dev1009}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.5.0.dev1007
+Version: 1.5.0.dev1009
 Summary: Deep learning software to decode EEG, ECG or MEG signals
 Author-email: Robin Tibor Schirrmeister <robintibor@gmail.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Alexandre Gramfort <agramfort@meta.com>
 Maintainer-email: Alexandre Gramfort <agramfort@meta.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Robin Tibor Schirrmeister <robintibor@gmail.com>

{braindecode-1.5.0.dev1007 → braindecode-1.5.0.dev1009}/braindecode/models/base.py

@@ -33,13 +33,25 @@ huggingface_hub = _soft_import(
 HAS_HF_HUB = huggingface_hub is not False
 
 
-class _BaseHubMixin:
-    pass
+_HF_INSTALL_HINT = (
+    "requires the `huggingface_hub` package. "
+    "Install with: pip install 'braindecode[hub]'"
+)
+
+
+class _BaseHubMixinStub:
+    @classmethod
+    def from_pretrained(cls, *args, **kwargs):
+        raise ImportError(f"{cls.__name__}.from_pretrained() {_HF_INSTALL_HINT}")
+
+    def push_to_hub(self, *args, **kwargs):
+        raise ImportError(f"{type(self).__name__}.push_to_hub() {_HF_INSTALL_HINT}")
 
 
 # Define base class for hub mixin
-if HAS_HF_HUB:
-    _BaseHubMixin: Type = huggingface_hub.PyTorchModelHubMixin  # type: ignore
+_BaseHubMixin: Type = (
+    huggingface_hub.PyTorchModelHubMixin if HAS_HF_HUB else _BaseHubMixinStub
+)
 
 
 def deprecated_args(obj, *old_new_args):

braindecode-1.5.0.dev1009/braindecode/version.py

@@ -0,0 +1 @@
+__version__ = "1.5.0.dev1009"

{braindecode-1.5.0.dev1007 → braindecode-1.5.0.dev1009/braindecode.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.5.0.dev1007
+Version: 1.5.0.dev1009
 Summary: Deep learning software to decode EEG, ECG or MEG signals
 Author-email: Robin Tibor Schirrmeister <robintibor@gmail.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Alexandre Gramfort <agramfort@meta.com>
 Maintainer-email: Alexandre Gramfort <agramfort@meta.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Robin Tibor Schirrmeister <robintibor@gmail.com>

{braindecode-1.5.0.dev1007 → braindecode-1.5.0.dev1009}/docs/whats_new.rst

@@ -289,6 +289,11 @@ Requirements
 
 Bugs
 =====
+- Improve the error message when :meth:`from_pretrained` or :meth:`push_to_hub`
+  are called without the optional ``huggingface_hub`` dependency installed.
+  Users now get a clear :class:`ImportError` with installation instructions
+  (``pip install 'braindecode[hub]'``) instead of an ``AttributeError``.
+  (:gh:`1024` by `@copilot`_)
 - Fix the documentation header "Cite Braindecode" announcement link: it used a bare
   ``cite.html`` URL, which browsers resolve relative to the current page path and led
   to 404s (for example from ``install/install.html``). The link is now built with

braindecode-1.5.0.dev1007/braindecode/version.py

@@ -1 +0,0 @@
-__version__ = "1.5.0.dev1007"