Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
david4096 committed Aug 28, 2024
1 parent 461fc88 commit 5402bfd
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# huggingface_rdf

`huggingface_rdf` is a Python tool that generates RDF (Resource Description Framework) data from datasets available on Hugging Face. This tool enables researchers and developers to convert data into a machine-readable format for enhanced querying and data analysis.

## Features

- Fetch datasets from Hugging Face.
- Convert datasets to RDF format.
- Generate Turtle (.ttl) files for easy integration with SPARQL endpoints.

## Installation

To install `huggingface_rdf`, clone the repository and install the package using pip:

```bash
git clone https://github.com/yourusername/huggingface_rdf.git
cd huggingface_rdf
pip install .
```

## Usage

After installing the package, you can use the command-line interface (CLI) to generate RDF data:

```
huggingface-rdf --fname huggingface.ttl --limit 10
```

Check out the `qlever_scripts` directory to get help loading the RDF into qlever for querying.

## Contributing

We welcome contributions! Please open an issue or submit a pull request!

0 comments on commit 5402bfd

Please sign in to comment.