Skip to content

Commit

Permalink
Update docs/source/contributing.probe.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Leon Derczynski <leonderczynski@gmail.com>
Signed-off-by: Erick Galinkin <erick.galinkin@gmail.com>
  • Loading branch information
erickgalinkin and leondz committed Sep 19, 2024
1 parent 9dc8468 commit 8888877
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/source/contributing.probe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,10 @@ Let's try running our new probe against a HuggingFace ``Pipeline`` using ``meta-
$ garak -m huggingface -n meta-llama/Llama-2-7b-chat-hf -p mynewprobe.MyNewProbe
If it all runs well, you'll get a log and a hitlog file, which tell you how successful your new probe was!
If you encounter errors, go through and try to address them.
If you encounter errors, go through and try to address them. You can look at the bottom of the `garak.log` file, whose path is printed in the output every time you call garak, to see what errors there are.

If you want to debug your probe interactively, try using something like ``p = garak._plugins.load_plugin("probes.mynewprobe.MyNewProbe")`` from a Python prompt to load the probe. The variable ``p`` will be assigned an instance of the probe (if instantiation was successful) and you can test a lot of the probe's intended functionality from here.


Finally, check a few properties:

Expand Down

0 comments on commit 8888877

Please sign in to comment.