Analyze Hugging Face Data in R via ODBC

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create data visualizations and use high-performance statistical functions to analyze Hugging Face data in Microsoft R Open.

Access Hugging Face data with pure R script and standard SQL. You can use the CData ODBC Driver for Hugging Face and the RODBC package to work with remote Hugging Face data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Hugging Face data and visualize Hugging Face data in R.

Install R

You can complement the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open (MRO).

Connect to Hugging Face as an ODBC Data Source

Information for connecting to Hugging Face follows, along with different instructions for configuring a DSN in Windows and Linux environments.

HuggingFace Hub uses token-based authentication to enable access to its API. The API provides access to machine learning models, datasets, spaces, papers, and other resources on the HuggingFace Hub platform.

Using API Key Authentication

To authenticate to HuggingFace Hub, you will need to provide an API Key (Access Token). To obtain your access token:

  1. Log in to your HuggingFace account at https://huggingface.co
  2. Navigate to Settings > Access Tokens
  3. Click "New token" to create a new access token
  4. Select the appropriate permissions (read or write)
  5. Copy the token value

After obtaining your access token, set the following connection properties:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your HuggingFace access token.

Example connection string

Profile=C:\profiles\HuggingFace.apip;ProfileSettings='APIKey=hf_xxxxxxxxxxxxxxxxxxxx';

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Windows

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Linux

If you are installing the CData ODBC Driver for Hugging Face in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData API Source]
Driver = CData ODBC Driver for Hugging Face
Description = My Description
Profile = C:\profiles\HuggingFace.apip
ProfileSettings = 'APIKey = hf_xxxxxxxxxxxxxxxxxxxx'

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Load the RODBC Package

To use the driver, download the RODBC package. In RStudio, click Tools -> Install Packages and enter RODBC in the Packages box.

After installing the RODBC package, the following line loads the package:

library(RODBC)

Note: This article uses RODBC version 1.3-12. Using Microsoft R Open, you can test with the same version, using the checkpoint capabilities of Microsoft's MRAN repository. The checkpoint command enables you to install packages from a snapshot of the CRAN repository, hosted on the MRAN repository. The snapshot taken Jan. 1, 2016 contains version 1.3-12.

library(checkpoint)
checkpoint("2016-01-01")

Connect to Hugging Face Data as an ODBC Data Source

You can connect to a DSN in R with the following line:

conn <- odbcConnect("CData API Source")

Schema Discovery

The driver models Hugging Face APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

sqlTables(conn)

Execute SQL Queries

Use the sqlQuery function to execute any SQL query supported by the Hugging Face API.

collections <- sqlQuery(conn, "SELECT ,  FROM Collections WHERE  = ''", believeNRows=FALSE, rows_at_time=1)

You can view the results in a data viewer window with the following command:

View(collections)

Plot Hugging Face Data

You can now analyze Hugging Face data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2))
barplot(collections$, main="Hugging Face Collections", names.arg = collections$, horiz=TRUE)

Ready to get started?

Connect to live data from Hugging Face with the API Driver

Connect to Hugging Face