Skip to content
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.

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

[DOC] Incorrect name on tutorial "Demand forecasting with the Temporal Fusion Transformer" #1722

Open
mbisan opened this issue Nov 26, 2024 · 1 comment · May be fixed by #1724
Open

[DOC] Incorrect name on tutorial "Demand forecasting with the Temporal Fusion Transformer" #1722

mbisan opened this issue Nov 26, 2024 · 1 comment · May be fixed by #1724
Labels
documentation Improvements or additions to documentation

Comments

@mbisan
Copy link

mbisan commented Nov 26, 2024

I've been trying to follow the tutorial on Demand forecasting with the Temporal Fusion Transformer, but found this error in the documentation:

On the step Find optimal learning rate, the optimizer parameter passed to from_dataset is "Ranger", with capital R.

Apparently, the base model class only admits the following (version 1.2.0):

optimizer (str): Optimizer, "ranger", "sgd", "adam", "adamw" or class name of optimizer in ``torch.optim``
                or ``pytorch_optimizer``.
                Alternatively, a class or function can be passed which takes parameters as first argument and
                a `lr` argument (optionally also `weight_decay`). Defaults to
                `"ranger" <https://pytorch-optimizers.readthedocs.io/en/latest/optimizer_api.html#ranger21>`_,
                if pytorch_optimizer is installed, otherwise "adam".

So the value passed must be changed to "ranger".

The current code causes a `ValueError: Optimizer of self.hparams.optimizer=Ranger unknown``.

The same error appears on the second time from_dataset is used, on the Train model step.

@mbisan mbisan added the documentation Improvements or additions to documentation label Nov 26, 2024
@fnhirwa
Copy link
Member

fnhirwa commented Dec 9, 2024

Nice catch @mbisan 😊
I am going to open a PR for a fix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants