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

Misleading doc for instance types and sizes in create_inference_endpoint #2509

Closed
aymeric-roucher opened this issue Sep 4, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@aymeric-roucher
Copy link

aymeric-roucher commented Sep 4, 2024

Describe the bug

The doc of create_inference_endpoint reports incorrect combinations of instance_type and instance_size, which creates misleading notions of what correct values would be.
It reports the incorrect values:

create_inference_endpoint(
    "my-endpoint-name",
    repository="gpt2",
    framework="pytorch",
    task="text-generation",
    accelerator="cpu",
    vendor="aws",
    region="us-east-1",
    type="protected",
    instance_size="medium",
    instance_type="c6i",
)

The doc should be corrected with proper values as referenced in the Inference Endpoints pricing page, and also link to that page for convenience.

Reproduction

No response

Logs

No response

System info

- huggingface_hub version: 0.24.6
- Platform: macOS-14.1-arm64-arm-64bit
- Python version: 3.12.0
- Running in iPython ?: No
- Running in notebook ?: No
- Running in Google Colab ?: No
- Token path ?: /Users/aymeric/.cache/huggingface/token
- Has saved token ?: True
- Who am I ?: m-ric
- Configured git credential helpers: osxkeychain, store
- FastAI: N/A
- Tensorflow: N/A
- Torch: 2.3.0
- Jinja2: 3.1.4
- Graphviz: N/A
- keras: N/A
- Pydot: N/A
- Pillow: 10.3.0
- hf_transfer: N/A
- gradio: N/A
- tensorboard: N/A
- numpy: 1.26.4
- pydantic: 2.5.2
- aiohttp: 3.9.3
- ENDPOINT: https://huggingface.co
- HF_HUB_CACHE: /Users/aymeric/.cache/huggingface/hub
- HF_ASSETS_CACHE: /Users/aymeric/.cache/huggingface/assets
- HF_TOKEN_PATH: /Users/aymeric/.cache/huggingface/token
- HF_HUB_OFFLINE: False
- HF_HUB_DISABLE_TELEMETRY: False
- HF_HUB_DISABLE_PROGRESS_BARS: None
- HF_HUB_DISABLE_SYMLINKS_WARNING: False
- HF_HUB_DISABLE_EXPERIMENTAL_WARNING: False
- HF_HUB_DISABLE_IMPLICIT_TOKEN: False
- HF_HUB_ENABLE_HF_TRANSFER: False
- HF_HUB_ETAG_TIMEOUT: 10
- HF_HUB_DOWNLOAD_TIMEOUT: 10
@aymeric-roucher aymeric-roucher added the bug Something isn't working label Sep 4, 2024
@aymeric-roucher
Copy link
Author

aymeric-roucher commented Sep 4, 2024

The strange thing is that this code seems to have been updated in this PR but the changes done't appear on the webpage although the changes were done back in May (I refreshed cache).

@Wauplin
Copy link
Contributor

Wauplin commented Sep 4, 2024

@aymeric-roucher the link you shared is a do page from 0.20.3
image

Always make sure to check the docs for latest version or main :)

@Wauplin Wauplin closed this as completed Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants
@Wauplin @aymeric-roucher and others