Skip to content

Commit

Permalink
v0.17.0
Browse files Browse the repository at this point in the history
  • Loading branch information
garymm committed Nov 21, 2024
0 parents commit 45660ed
Show file tree
Hide file tree
Showing 93 changed files with 2,672 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/checks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: checks
on: # yamllint disable-line rule:truthy
pull_request:
push:
branches:
- master
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
env:
CARGO_TERM_COLOR: always
steps:
- uses: actions/checkout@v4
- name: Install Rust toolchains
run: rustup --quiet toolchain install --profile minimal stable nightly
- uses: Swatinem/rust-cache@v2
- name: Build
run: cargo build --all-targets --all-features

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/target/
**/*.rs.bk
Cargo.lock
23 changes: 23 additions & 0 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
92 changes: 92 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
.gitignore
.openapi-generator-ignore
.travis.yml
Cargo.toml
README.md
docs/V1beta1AlgorithmSetting.md
docs/V1beta1AlgorithmSpec.md
docs/V1beta1CollectorSpec.md
docs/V1beta1ConfigMapSource.md
docs/V1beta1EarlyStoppingRule.md
docs/V1beta1EarlyStoppingSetting.md
docs/V1beta1EarlyStoppingSpec.md
docs/V1beta1Experiment.md
docs/V1beta1ExperimentCondition.md
docs/V1beta1ExperimentList.md
docs/V1beta1ExperimentSpec.md
docs/V1beta1ExperimentStatus.md
docs/V1beta1FeasibleSpace.md
docs/V1beta1FileSystemPath.md
docs/V1beta1FilterSpec.md
docs/V1beta1GraphConfig.md
docs/V1beta1Metric.md
docs/V1beta1MetricStrategy.md
docs/V1beta1MetricsCollectorSpec.md
docs/V1beta1NasConfig.md
docs/V1beta1ObjectiveSpec.md
docs/V1beta1Observation.md
docs/V1beta1Operation.md
docs/V1beta1OptimalTrial.md
docs/V1beta1ParameterAssignment.md
docs/V1beta1ParameterSpec.md
docs/V1beta1SourceSpec.md
docs/V1beta1Suggestion.md
docs/V1beta1SuggestionCondition.md
docs/V1beta1SuggestionList.md
docs/V1beta1SuggestionSpec.md
docs/V1beta1SuggestionStatus.md
docs/V1beta1Trial.md
docs/V1beta1TrialAssignment.md
docs/V1beta1TrialCondition.md
docs/V1beta1TrialList.md
docs/V1beta1TrialParameterSpec.md
docs/V1beta1TrialSource.md
docs/V1beta1TrialSpec.md
docs/V1beta1TrialStatus.md
docs/V1beta1TrialTemplate.md
git_push.sh
src/apis/configuration.rs
src/apis/mod.rs
src/lib.rs
src/models/_v1beta1_suggestion.rs
src/models/_v1beta1_suggestion_condition.rs
src/models/_v1beta1_suggestion_list.rs
src/models/_v1beta1_suggestion_spec.rs
src/models/_v1beta1_suggestion_status.rs
src/models/_v1beta1_trial.rs
src/models/_v1beta1_trial_assignment.rs
src/models/_v1beta1_trial_condition.rs
src/models/_v1beta1_trial_list.rs
src/models/_v1beta1_trial_spec.rs
src/models/_v1beta1_trial_status.rs
src/models/mod.rs
src/models/v1beta1_algorithm_setting.rs
src/models/v1beta1_algorithm_spec.rs
src/models/v1beta1_collector_spec.rs
src/models/v1beta1_config_map_source.rs
src/models/v1beta1_early_stopping_rule.rs
src/models/v1beta1_early_stopping_setting.rs
src/models/v1beta1_early_stopping_spec.rs
src/models/v1beta1_experiment.rs
src/models/v1beta1_experiment_condition.rs
src/models/v1beta1_experiment_list.rs
src/models/v1beta1_experiment_spec.rs
src/models/v1beta1_experiment_status.rs
src/models/v1beta1_feasible_space.rs
src/models/v1beta1_file_system_path.rs
src/models/v1beta1_filter_spec.rs
src/models/v1beta1_graph_config.rs
src/models/v1beta1_metric.rs
src/models/v1beta1_metric_strategy.rs
src/models/v1beta1_metrics_collector_spec.rs
src/models/v1beta1_nas_config.rs
src/models/v1beta1_objective_spec.rs
src/models/v1beta1_observation.rs
src/models/v1beta1_operation.rs
src/models/v1beta1_optimal_trial.rs
src/models/v1beta1_parameter_assignment.rs
src/models/v1beta1_parameter_spec.rs
src/models/v1beta1_source_spec.rs
src/models/v1beta1_trial_parameter_spec.rs
src/models/v1beta1_trial_source.rs
src/models/v1beta1_trial_template.rs
1 change: 1 addition & 0 deletions .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
5.3.1
14 changes: 14 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[package]
name = "katib"
version = "0.17.0"
authors = ["OpenAPI Generator team and contributors"]
edition = "2018"

[dependencies]
kubernetes = { git = "https://github.com/Astera-org/kubernetes-client-rust.git", tag = "v1.31.0", version = "1.31.0" }
serde = "^1.0"
serde_derive = "^1.0"
serde_json = "^1.0"
url = "^2.2"

[dev-dependencies]
83 changes: 83 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Rust API client for katib

Generated by ./regen.bash


## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: v1beta1-0.1
- Package version: 0.17.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `katib` and add the following to `Cargo.toml` under `[dependencies]`:

```
katib = { path = "./katib" }
```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------


## Documentation For Models

- [V1beta1AlgorithmSetting](docs/V1beta1AlgorithmSetting.md)
- [V1beta1AlgorithmSpec](docs/V1beta1AlgorithmSpec.md)
- [V1beta1CollectorSpec](docs/V1beta1CollectorSpec.md)
- [V1beta1ConfigMapSource](docs/V1beta1ConfigMapSource.md)
- [V1beta1EarlyStoppingRule](docs/V1beta1EarlyStoppingRule.md)
- [V1beta1EarlyStoppingSetting](docs/V1beta1EarlyStoppingSetting.md)
- [V1beta1EarlyStoppingSpec](docs/V1beta1EarlyStoppingSpec.md)
- [V1beta1Experiment](docs/V1beta1Experiment.md)
- [V1beta1ExperimentCondition](docs/V1beta1ExperimentCondition.md)
- [V1beta1ExperimentList](docs/V1beta1ExperimentList.md)
- [V1beta1ExperimentSpec](docs/V1beta1ExperimentSpec.md)
- [V1beta1ExperimentStatus](docs/V1beta1ExperimentStatus.md)
- [V1beta1FeasibleSpace](docs/V1beta1FeasibleSpace.md)
- [V1beta1FileSystemPath](docs/V1beta1FileSystemPath.md)
- [V1beta1FilterSpec](docs/V1beta1FilterSpec.md)
- [V1beta1GraphConfig](docs/V1beta1GraphConfig.md)
- [V1beta1Metric](docs/V1beta1Metric.md)
- [V1beta1MetricStrategy](docs/V1beta1MetricStrategy.md)
- [V1beta1MetricsCollectorSpec](docs/V1beta1MetricsCollectorSpec.md)
- [V1beta1NasConfig](docs/V1beta1NasConfig.md)
- [V1beta1ObjectiveSpec](docs/V1beta1ObjectiveSpec.md)
- [V1beta1Observation](docs/V1beta1Observation.md)
- [V1beta1Operation](docs/V1beta1Operation.md)
- [V1beta1OptimalTrial](docs/V1beta1OptimalTrial.md)
- [V1beta1ParameterAssignment](docs/V1beta1ParameterAssignment.md)
- [V1beta1ParameterSpec](docs/V1beta1ParameterSpec.md)
- [V1beta1SourceSpec](docs/V1beta1SourceSpec.md)
- [V1beta1Suggestion](docs/V1beta1Suggestion.md)
- [V1beta1SuggestionCondition](docs/V1beta1SuggestionCondition.md)
- [V1beta1SuggestionList](docs/V1beta1SuggestionList.md)
- [V1beta1SuggestionSpec](docs/V1beta1SuggestionSpec.md)
- [V1beta1SuggestionStatus](docs/V1beta1SuggestionStatus.md)
- [V1beta1Trial](docs/V1beta1Trial.md)
- [V1beta1TrialAssignment](docs/V1beta1TrialAssignment.md)
- [V1beta1TrialCondition](docs/V1beta1TrialCondition.md)
- [V1beta1TrialList](docs/V1beta1TrialList.md)
- [V1beta1TrialParameterSpec](docs/V1beta1TrialParameterSpec.md)
- [V1beta1TrialSource](docs/V1beta1TrialSource.md)
- [V1beta1TrialSpec](docs/V1beta1TrialSpec.md)
- [V1beta1TrialStatus](docs/V1beta1TrialStatus.md)
- [V1beta1TrialTemplate](docs/V1beta1TrialTemplate.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author


12 changes: 12 additions & 0 deletions docs/V1beta1AlgorithmSetting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# V1beta1AlgorithmSetting

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | Option<**String**> | Name is setting name. | [optional]
**value** | Option<**String**> | Value is the setting value. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/V1beta1AlgorithmSpec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# V1beta1AlgorithmSpec

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**algorithm_name** | Option<**String**> | HP or NAS algorithm name. | [optional]
**algorithm_settings** | Option<[**Vec<crate::models::V1beta1AlgorithmSetting>**](v1beta1.AlgorithmSetting.md)> | Key-value pairs representing settings for suggestion algorithms. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/V1beta1CollectorSpec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# V1beta1CollectorSpec

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**custom_collector** | Option<[**crate::models::V1Container**](v1.Container.md)> | | [optional]
**kind** | Option<**String**> | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions docs/V1beta1ConfigMapSource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# V1beta1ConfigMapSource

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**config_map_name** | Option<**String**> | Name of config map where trial template is located | [optional]
**config_map_namespace** | Option<**String**> | Namespace of config map where trial template is located | [optional]
**template_path** | Option<**String**> | Path in config map where trial template is located | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/V1beta1EarlyStoppingRule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# V1beta1EarlyStoppingRule

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comparison** | Option<**String**> | Comparison defines correlation between name and value. | [optional]
**name** | Option<**String**> | Name contains metric name for the rule. | [optional]
**start_step** | Option<**i32**> | StartStep defines quantity of intermediate results that should be received before applying the rule. If start step is empty, rule is applied from the first recorded metric. | [optional]
**value** | Option<**String**> | Value contains metric value for the rule. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/V1beta1EarlyStoppingSetting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# V1beta1EarlyStoppingSetting

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | Option<**String**> | Name is the setting name. | [optional]
**value** | Option<**String**> | Value is the setting value. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/V1beta1EarlyStoppingSpec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# V1beta1EarlyStoppingSpec

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**algorithm_name** | Option<**String**> | Early stopping algorithm name. | [optional]
**algorithm_settings** | Option<[**Vec<crate::models::V1beta1EarlyStoppingSetting>**](v1beta1.EarlyStoppingSetting.md)> | Key-value pairs representing settings for early stopping algorithm. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions docs/V1beta1Experiment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# V1beta1Experiment

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_version** | Option<**String**> | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**kind** | Option<**String**> | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | Option<[**crate::models::V1ObjectMeta**](v1.ObjectMeta.md)> | | [optional]
**spec** | Option<[**crate::models::V1beta1ExperimentSpec**](v1beta1.ExperimentSpec.md)> | | [optional]
**status** | Option<[**crate::models::V1beta1ExperimentStatus**](v1beta1.ExperimentStatus.md)> | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


16 changes: 16 additions & 0 deletions docs/V1beta1ExperimentCondition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# V1beta1ExperimentCondition

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**last_transition_time** | Option<[**crate::models::V1Time**](v1.Time.md)> | | [optional]
**last_update_time** | Option<[**crate::models::V1Time**](v1.Time.md)> | | [optional]
**message** | Option<**String**> | A human readable message indicating details about the transition. | [optional]
**reason** | Option<**String**> | The reason for the condition's last transition. | [optional]
**status** | **String** | Status of the condition, one of True, False, Unknown. | [default to ]
**_type** | **String** | Type of experiment condition. | [default to ]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/V1beta1ExperimentList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# V1beta1ExperimentList

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_version** | Option<**String**> | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**items** | [**Vec<crate::models::V1beta1Experiment>**](v1beta1.Experiment.md) | |
**kind** | Option<**String**> | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | Option<[**crate::models::V1ListMeta**](v1.ListMeta.md)> | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading

0 comments on commit 45660ed

Please sign in to comment.