pulp_hugging_face_client

PulpHuggingFaceClient - the Ruby gem for the Pulp 3 API

Fetch, Upload, Organize, and Distribute Software Packages

This SDK is automatically generated by the OpenAPI Generator project:

API version: v3
Package version: 0.1.0
Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://pulpproject.org

Installation

Build a gem

To build the Ruby code into a gem:

gem build pulp_hugging_face_client.gemspec

Then either install the gem locally:

gem install ./pulp_hugging_face_client-0.1.0.gem

(for development, run gem install --dev ./pulp_hugging_face_client-0.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'pulp_hugging_face_client', '~> 0.1.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'pulp_hugging_face_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pulp_hugging_face_client'

# Setup authorization
PulpHuggingFaceClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = PulpHuggingFaceClient::ContentHuggingFaceApi.new
hugging_face_hugging_face_content = PulpHuggingFaceClient::HuggingFaceHuggingFaceContent.new({artifact: 'artifact_example', relative_path: 'relative_path_example', repo_id: 'repo_id_example'}) # HuggingFaceHuggingFaceContent | 
opts = {
  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
}

begin
  #Create a hugging face content
  result = api_instance.create(hugging_face_hugging_face_content, opts)
  p result
rescue PulpHuggingFaceClient::ApiError => e
  puts "Exception when calling ContentHuggingFaceApi->create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:24817

Class	Method	HTTP request	Description
PulpHuggingFaceClient::ContentHuggingFaceApi	create	POST /pulp/api/v3/content/hugging_face/hugging-face/	Create a hugging face content
PulpHuggingFaceClient::ContentHuggingFaceApi	list	GET /pulp/api/v3/content/hugging_face/hugging-face/	List hugging face contents
PulpHuggingFaceClient::ContentHuggingFaceApi	read	GET hugging_face_hugging_face_content_href	Inspect a hugging face content
PulpHuggingFaceClient::ContentHuggingFaceApi	set_label	POST hugging_face_hugging_face_content_hrefset_label/	Set a label
PulpHuggingFaceClient::ContentHuggingFaceApi	unset_label	POST hugging_face_hugging_face_content_hrefunset_label/	Unset a label
PulpHuggingFaceClient::DistributionsHuggingFaceApi	create	POST /pulp/api/v3/distributions/hugging_face/hugging-face/	Create a hugging face distribution
PulpHuggingFaceClient::DistributionsHuggingFaceApi	delete	DELETE hugging_face_hugging_face_distribution_href	Delete a hugging face distribution
PulpHuggingFaceClient::DistributionsHuggingFaceApi	list	GET /pulp/api/v3/distributions/hugging_face/hugging-face/	List hugging face distributions
PulpHuggingFaceClient::DistributionsHuggingFaceApi	partial_update	PATCH hugging_face_hugging_face_distribution_href	Update a hugging face distribution
PulpHuggingFaceClient::DistributionsHuggingFaceApi	read	GET hugging_face_hugging_face_distribution_href	Inspect a hugging face distribution
PulpHuggingFaceClient::DistributionsHuggingFaceApi	set_label	POST hugging_face_hugging_face_distribution_hrefset_label/	Set a label
PulpHuggingFaceClient::DistributionsHuggingFaceApi	unset_label	POST hugging_face_hugging_face_distribution_hrefunset_label/	Unset a label
PulpHuggingFaceClient::DistributionsHuggingFaceApi	update	PUT hugging_face_hugging_face_distribution_href	Update a hugging face distribution
PulpHuggingFaceClient::PublicationsHuggingFaceApi	create	POST /pulp/api/v3/publications/hugging_face/hugging-face/	Create a hugging face publication
PulpHuggingFaceClient::PublicationsHuggingFaceApi	delete	DELETE hugging_face_hugging_face_publication_href	Delete a hugging face publication
PulpHuggingFaceClient::PublicationsHuggingFaceApi	list	GET /pulp/api/v3/publications/hugging_face/hugging-face/	List hugging face publications
PulpHuggingFaceClient::PublicationsHuggingFaceApi	read	GET hugging_face_hugging_face_publication_href	Inspect a hugging face publication
PulpHuggingFaceClient::RemotesHuggingFaceApi	create	POST /pulp/api/v3/remotes/hugging_face/hugging-face/	Create a hugging face remote
PulpHuggingFaceClient::RemotesHuggingFaceApi	delete	DELETE hugging_face_hugging_face_remote_href	Delete a hugging face remote
PulpHuggingFaceClient::RemotesHuggingFaceApi	list	GET /pulp/api/v3/remotes/hugging_face/hugging-face/	List hugging face remotes
PulpHuggingFaceClient::RemotesHuggingFaceApi	partial_update	PATCH hugging_face_hugging_face_remote_href	Update a hugging face remote
PulpHuggingFaceClient::RemotesHuggingFaceApi	read	GET hugging_face_hugging_face_remote_href	Inspect a hugging face remote
PulpHuggingFaceClient::RemotesHuggingFaceApi	set_label	POST hugging_face_hugging_face_remote_hrefset_label/	Set a label
PulpHuggingFaceClient::RemotesHuggingFaceApi	unset_label	POST hugging_face_hugging_face_remote_hrefunset_label/	Unset a label
PulpHuggingFaceClient::RemotesHuggingFaceApi	update	PUT hugging_face_hugging_face_remote_href	Update a hugging face remote
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	create	POST /pulp/api/v3/repositories/hugging_face/hugging-face/	Create a hugging face repository
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	delete	DELETE hugging_face_hugging_face_repository_href	Delete a hugging face repository
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	list	GET /pulp/api/v3/repositories/hugging_face/hugging-face/	List hugging face repositorys
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	modify	POST hugging_face_hugging_face_repository_hrefmodify/	Modify Repository Content
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	partial_update	PATCH hugging_face_hugging_face_repository_href	Update a hugging face repository
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	read	GET hugging_face_hugging_face_repository_href	Inspect a hugging face repository
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	set_label	POST hugging_face_hugging_face_repository_hrefset_label/	Set a label
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	sync	POST hugging_face_hugging_face_repository_hrefsync/	Sync from remote
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	unset_label	POST hugging_face_hugging_face_repository_hrefunset_label/	Unset a label
PulpHuggingFaceClient::RepositoriesHuggingFaceApi	update	PUT hugging_face_hugging_face_repository_href	Update a hugging face repository
PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi	delete	DELETE hugging_face_hugging_face_repository_version_href	Delete a repository version
PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi	list	GET hugging_face_hugging_face_repository_hrefversions/	List repository versions
PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi	read	GET hugging_face_hugging_face_repository_version_href	Inspect a repository version
PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi	repair	POST hugging_face_hugging_face_repository_version_hrefrepair/