huggingface_api_cpp

A collection of C++ libraries to interact with the Hugging Face API (C++ version of huggingface/huggingface.js).

• Prerequisite
• Usage example

Prerequisite

• Bazel (or Bazelisk for convenience)

Usage example

For more details, see ./example/inference/main.cc.

Command:

$ cd /path/to/huggingface_api_cpp/
$ bazel run //example/inference:main -- /path/to/huggingface_api_cpp/huggingface_api_cpp/inference/ YOUR_API_KEY

Code:

#include "huggingface_api_cpp/inference.h"

using namespace huggingface_api_cpp::inference;

int main() {
  const std::filesystem::path directory_path = "/path/to/huggingface_api_cpp/huggingface_api_cpp/inference/";
  const std::string api_key = "YOUR_API_KEY";

  HfInference hf_inference(api_key);

  /////////////////////////////////
  // Natural Language Processing //
  /////////////////////////////////

  const std::string output_string = hf_inference.textGeneration(
    {.model = "gpt2"},
    {.inputs = "The answer to the universe is"}
  );
  /*
  Output:
  [
    {
      "generated_text": "The answer to the universe is one in which we have no choice in the matter in which we live. And this is only possible through reason. If you are to understand physics, it is only necessary to understand the very nature of the matter in one"
    }
  ]
  */

  const std::string output_string = hf_inference.tokenClassification(
    {.model = "dbmdz/bert-large-cased-finetuned-conll03-english"},
    {
      .inputs = "My name is Sarah Jessica Parker but you can call me Jessica",
      .parameters_opt = TokenClassificationArgs::Parameters{
        .aggregation_strategy_opt = TokenClassificationArgs::Parameters::AggregationStrategy::kSimple
      }
    }
  );
  /*
  Output:
  [
    {
      "end": 31,
      "entity_group": "PER",
      "score": 0.9991335868835449,
      "start": 11,
      "word": "Sarah Jessica Parker"
    },
    {
      "end": 59,
      "entity_group": "PER",
      "score": 0.9979913234710693,
      "start": 52,
      "word": "Jessica"
    }
  ]
  */

  //////////////////////
  // Audio Processing //
  //////////////////////

  const std::string output_string = hf_inference.automaticSpeechRecognition(
    {.model = "facebook/wav2vec2-large-960h-lv60-self"},
    {.data = directory_path / "test" / "sample1.flac"}
  );
  /*
  Output:
  {
    "text": "GOING ALONG SLUSHY COUNTRY ROADS AND SPEAKING TO DAMP AUDIENCES IN DRAUGHTY SCHOOLROOMS DAY AFTER DAY FOR A FORTNIGHT HE'LL HAVE TO PUT IN AN APPEARANCE AT SOME PLACE OF WORSHIP ON SUNDAY MORNING AND HE CAN COME TO US IMMEDIATELY AFTERWARDS"
  }
  */

  /////////////////////
  // Computer Vision //
  /////////////////////

  const std::filesystem::path output_file_path = directory_path / "test" / "blob.png";
  hf_inference.setOutputFilePath(output_file_path);

  const std::string output_string = hf_inference.textToImage(
    {.model = "stabilityai/stable-diffusion-2"},
    {
      .inputs = "award winning high resolution photo of a giant tortoise/((ladybird)) hybrid, [trending on artstation]",
      .negative_prompt_opt = "blurry"
    }
  );
  /*
  Output:
  A generated file will be saved in `output_file_path`.
  */

  return EXIT_SUCCESS;
}

The generated image by HfInference::textToImage() can be found in ./huggingface_api_cpp/inference/test/blob.png.