learneng-space/idioms

Idioms API

This is a Hugging Face Space that provides an API to retrieve 50 random idioms from the UCSC-Admire/idiom-SFT-dataset-561-2024-12-06_00-40-30 dataset. The API is built using Flask and runs in a Docker container.

API Endpoint

• —URL: https://<username>-idioms.hf.space/api/idioms
• —Method: GET
• —Response: JSON array of 50 idioms, each with the following fields:
• —idiom: The idiom phrase (from the dataset's compound field).
• —example: An example sentence using the idiom (from the dataset's sentence field).
• —definition: The compound type description (from the Compound Type field in the dataset's output JSON, with quotes removed).

Example response:

[
  {
    "idiom": "across the board",
    "example": "The company implemented changes across the board to improve efficiency.",
    "definition": "Literal - Direct spatial description of marking a line across a surface"
  },
  ...
]

Setup Instructions

1. 1.Clone the Repository:

   git clone https://huggingface.co/spaces/<username>/idioms
   cd idioms

1. 1.File Structure:
2. 2.Dockerfile: Defines the Docker container setup with Python 3.10-slim.
3. 3.app.py: Flask application that serves the /api/idioms endpoint.
4. 4.requirements.txt: Lists dependencies (flask and datasets).
5. 5.README.md: This file.

1. 1.Push Changes:

   git add .
   git commit -m "Update app with idioms API"
   git push

1. 1.Deploy:
2. 2.Hugging Face Spaces automatically builds and deploys the Docker container.
3. 3.Check the Space's status in the Hugging Face interface.

1. 1.Test the API:

   curl https://<username>-idioms.hf.space/api/idioms

Dependencies

• —flask==2.3.3: Web framework for the API.
• —datasets==2.21.0: Hugging Face library to load the dataset.

Notes

• —Ensure your Hugging Face account has access to the dataset.
• —The output field in the dataset is parsed as JSON to extract Compound Type. If parsing fails, an empty string is returned for definition.
• —The API runs on port 8000, which is standard for Hugging Face Spaces.

For issues, check the Space's logs in the Hugging Face interface.