Skip to content

docs: fix note on algorithm argument checking #158

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.

Sign up for GitHub

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

Merged
johannaSommer merged 1 commit into from
Jun 11, 2025
Merged

docs: fix note on algorithm argument checking #158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/user_manual/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,12 +187,11 @@ For example, looking at the :doc:`Algorithm Overview </compression>` we see that
- ``add_processor()``
* - ``data``
- Loads a dataset.
- ``add_dataset()``
- ``add_data()``

.. note::

If you try to activate a algorithm that requires a dataset, tokenizer or processor and haven’t added them to the ``SmashConfig``, you will receive an error.
Make sure to add them before activating the algorithm! If you want to know which algorithms require a dataset, tokenizer or processor, you can look at the :doc:`Algorithm Overview </compression>`.
If you try to add a text dataset, you will have to specify a tokenizer first.

Configure Tokenizers, Processors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down