[bug] Cannot import 'GibberishText' from 'guardrails.hub'

[RoyKulik]

Describe the bug
A clear and concise description of what the bug is.
ImportError: cannot import name 'RegexMatch' from 'guardrails.hub'

Even though installation from hub successful.
I see the init.py script is empty, the comments suggests that maybe it should have imports.

# Should contain imports for all validators
# Will be auto-populated by the installation script

To Reproduce
Steps to reproduce the behavior:

1. Im using MacOs and Python 3.12.1
2. Starting empty pip venv
3. installing guardrails-ai (tried both 0.6.3 and 0.6)

Expected behavior
Expected valid import

Library version:
Version 0.6.3

Additional context
I have no Idea why this fails for ANY installation from the hub -
the import always fails.

[dtam]

hi @RoyKulik could you try installing from the python interface with log level debug like below and let us know what the output is

import guardrails as gd
import logging
logging.basicConfig(level=logging.DEBUG)
gd.install("hub://guardrails/regex_match")

this can be placed in a text.py and executed with python test.py

[ChiragChauhan4579]

No guard installation seems to work.

[ChiragChauhan4579]

@dtam Your solution also doesn't work.

I have tried these all methods but everything is failing:

1. Pre-existing guardrails setup in the Docker container
2. Local setup in python 3.10 env
3. New fresh environment with python 3.10/3.12 both versions tested
4. Installing via the library as you suggested, pasting the error below

DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): hub.api.guardrailsai.com:443
DEBUG:urllib3.connectionpool:https://hub.api.guardrailsai.com:443 "GET /validator/guardrails/gibberish_text/manifest HTTP/1.1" 200 1377
DEBUG:guardrails-cli:running post install script...
2025-02-19 10:28:44.480566: I tensorflow/core/util/port.cc:153] oneDNN custom operations are on. You may see slightly different numerical results due to floating-point round-off errors from different computation orders. To turn them off, set the environment variable TF_ENABLE_ONEDNN_OPTS=0.
2025-02-19 10:28:46.458914: I tensorflow/core/util/port.cc:153] oneDNN custom operations are on. You may see slightly different numerical results due to floating-point round-off errors from different computation orders. To turn them off, set the environment variable TF_ENABLE_ONEDNN_OPTS=0.
Traceback (most recent call last):
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\utils_http.py", line 406, in hf_raise_for_status
response.raise_for_status()
File "C:\Users\Chirag\anaconda3\lib\site-packages\requests\models.py", line 1024, in raise_for_status
raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 401 Client Error: Unauthorized for url: https://huggingface.co/madhurjindal/autonlp-Gibberish-Detector-492513457/resolve/main/config.json

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
File "C:\Users\Chirag\anaconda3\lib\site-packages\transformers\utils\hub.py", line 403, in cached_file
resolved_file = hf_hub_download(
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\utils_validators.py", line 114, in _inner_fn
return fn(*args, **kwargs)
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\file_download.py", line 860, in hf_hub_download
return _hf_hub_download_to_cache_dir(
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\file_download.py", line 967, in _hf_hub_download_to_cache_dir
_raise_on_head_call_error(head_call_error, force_download, local_files_only)
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\file_download.py", line 1482, in _raise_on_head_call_error
raise head_call_error
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\file_download.py", line 1374, in _get_metadata_or_catch_error
metadata = get_hf_file_metadata(
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\utils_validators.py", line 114, in _inner_fn
return fn(*args, **kwargs)
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\file_download.py", line 1294, in get_hf_file_metadata
r = _request_wrapper(
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\file_download.py", line 278, in _request_wrapper
response = _request_wrapper(
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\file_download.py", line 302, in _request_wrapper
hf_raise_for_status(response)
File "C:\Users\Chirag\anaconda3\lib\site-packages\huggingface_hub\utils_http.py", line 454, in hf_raise_for_status
raise _format(RepositoryNotFoundError, message, response) from e
huggingface_hub.errors.RepositoryNotFoundError: 401 Client Error. (Request ID: Root=1-67b5650c-5821f17764b199d015c42dcc;cd8daab3-a34d-403d-80c4-8b3a56d55eed)

Repository Not Found for url: https://huggingface.co/madhurjindal/autonlp-Gibberish-Detector-492513457/resolve/main/config.json.
Please make sure you specified the correct repo_id and repo_type.
If you are trying to access a private or gated repo, make sure you are authenticated.
Invalid credentials in Authorization header

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
File "C:\Users\Chirag\anaconda3\lib\site-packages\guardrails_grhub_gibberish_text\post-install.py", line 57, in
pipe = pipeline(
File "C:\Users\Chirag\anaconda3\lib\site-packages\transformers\pipelines_init_.py", line 812, in pipeline
resolved_config_file = cached_file(
File "C:\Users\Chirag\anaconda3\lib\site-packages\transformers\utils\hub.py", line 426, in cached_file
raise EnvironmentError(
OSError: madhurjindal/autonlp-Gibberish-Detector-492513457 is not a local folder and is not a valid model identifier listed on 'https://huggingface.co/models'
If this is a private repository, make sure to pass a token having permission to this repo either by logging in with huggingface-cli login or by passing token=<your_token>

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
File "C:\Users\Chirag\anaconda3\lib\site-packages\guardrails_grhub_gibberish_text\post-install.py", line 63, in
raise RuntimeError(f"Failed to setup pipeline: {e}") from e
RuntimeError: Failed to setup pipeline: madhurjindal/autonlp-Gibberish-Detector-492513457 is not a local folder and is not a valid model identifier listed on 'https://huggingface.co/models'
If this is a private repository, make sure to pass a token having permission to this repo either by logging in with huggingface-cli login or by passing token=<your_token>
ERROR:guardrails-cli:Failed to run post install script for guardrails/gibberish_text
Exit code: 1
stdout: b''
Traceback (most recent call last):
File "C:\Users\Chirag\anaconda3\lib\site-packages\guardrails\hub\validator_package_service.py", line 202, in run_post_install
subprocess.check_output(command)
File "C:\Users\Chirag\anaconda3\lib\subprocess.py", line 421, in check_output
return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
File "C:\Users\Chirag\anaconda3\lib\subprocess.py", line 526, in run
raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['C:\Users\Chirag\anaconda3\python.exe', 'C:\Users\Chirag\anaconda3\lib\site-packages\guardrails_grhub_gibberish_text\post-install.py']' returned non-zero exit status 1.

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "C:\Users\Chirag\Desktop\MLOps\MLOps-Ollama\src\test.py", line 4, in
gd.install("hub://guardrails/gibberish_text")
File "C:\Users\Chirag\anaconda3\lib\site-packages\guardrails\hub\install.py", line 129, in install
ValidatorPackageService.run_post_install(
File "C:\Users\Chirag\anaconda3\lib\site-packages\guardrails\hub\validator_package_service.py", line 211, in run_post_install
raise FailedPackageInstallationPostInstall(
guardrails.hub.validator_package_service.FailedPackageInstallationPostInstall: Failed to run post install script for guardrails/gibberish_text

[CalebCourier]

@ChiragChauhan4579 As shown in the error you shared, GibberishText uses a Huggingface model which requires a token, typically set as the HF_TOKEN environment variable. This should have been documented in the README but it was not. I'm updating the documentation accordingly now.

[CalebCourier]

@RoyKulik If @dtam's fix works for you, it could be that you have guardrails installed in another environment in a directory above your current directory. Since installing the guardrails-ai package creates the bin executable for the guardrails cli, and OSX-like operating systems evaluate these from the top-down of the file directory, sometimes the terminal will use a higher installation path if the current environment has not been sourced after installation.

You can check this on MacOS and Linux by running which guardrails, or on Windows with where guardrails, and look at the path that is printed out. It should point to your current virtual environment if everything is sourced correctly. If it does not, try re-sourcing your virtual environment.

[CalebCourier]

@dtam Regarding @ChiragChauhan4579's issue: guardrails-ai/gibberish_text#2

[ChiragChauhan4579]

@CalebCourier Thanks man!, working fine now.

[JosephCatrambone]

Marking resolved. Thanks Caleb!