RHOAIENG-3458: Add a models command to the CLI #227
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /* | ||
| Copyright 2023 KStreamer Authors | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package commands | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
|
|
||
| "github.com/charmbracelet/bubbles/table" | ||
| tea "github.com/charmbracelet/bubbletea" | ||
| "github.com/charmbracelet/lipgloss" | ||
| openapiclient "github.com/kubeflow/model-registry/pkg/openapi" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| var baseStyle = lipgloss.NewStyle(). | ||
| BorderStyle(lipgloss.NormalBorder()). | ||
| BorderForeground(lipgloss.Color("#04B575")) | ||
|
|
||
| var errorStyle = lipgloss.NewStyle(). | ||
| Foreground(lipgloss.Color("#FF0000")). | ||
| Bold(true). | ||
| Height(4). | ||
| Width(120) | ||
|
|
||
| type registeredModelsMsg *openapiclient.RegisteredModelList | ||
|
|
||
| type errMsg struct{ err error } | ||
|
|
||
| func (e errMsg) Error() string { return e.err.Error() } | ||
|
|
||
| func listRegisteredModels() tea.Msg { | ||
| configuration := openapiclient.NewConfiguration() | ||
| configuration.Servers = openapiclient.ServerConfigurations{ | ||
| { | ||
| URL: modelRegistryURL, | ||
| }, | ||
| } | ||
|
|
||
| apiClient := openapiclient.NewAPIClient(configuration) | ||
| models, httpRes, err := apiClient.ModelRegistryServiceAPI.GetRegisteredModels( | ||
| context.Background(), | ||
| ).Execute() | ||
| if err != nil { | ||
| return errMsg{err} | ||
| } | ||
| if httpRes.StatusCode != 200 { | ||
| fmt.Printf("not 200: %d\n", httpRes.StatusCode) | ||
|
There was a problem hiding this comment. Is this log message redundant, given the error message being returned? How does fmt.Printf get handled in the interactive text UI? |
||
| return errMsg{ | ||
| fmt.Errorf( | ||
| "Failed to get models, calling the model registry API returned status code %d\n", httpRes.StatusCode, | ||
| ), | ||
| } | ||
| } | ||
| return registeredModelsMsg(models) | ||
| } | ||
|
|
||
| type model struct { | ||
|
There was a problem hiding this comment. I wonder if this would be better named more specifically to say that |
||
| registeredModelsList *openapiclient.RegisteredModelList | ||
| cursor int | ||
| choices int | ||
|
Comment on lines
+75
to
+76
There was a problem hiding this comment. @devguyio I noticed that these are not used. Are they a preparation for the next step when a use will be able to choose a model and operate on it? |
||
| err error | ||
| } | ||
|
|
||
| func (m model) Init() tea.Cmd { | ||
| return listRegisteredModels | ||
| } | ||
|
|
||
| func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) { | ||
| switch msg := msg.(type) { | ||
| case errMsg: | ||
| m.err = msg | ||
| return m, tea.Quit | ||
|
|
||
| case registeredModelsMsg: | ||
| m.registeredModelsList = msg | ||
| m.choices = len(m.registeredModelsList.Items) | ||
| return m, tea.Quit | ||
| } | ||
| return m, nil | ||
| } | ||
|
|
||
| func (m model) View() string { | ||
| if m.err != nil { | ||
| return errorStyle.Render(fmt.Sprintf("Error: %s", m.err)) | ||
| // return "" | ||
|
There was a problem hiding this comment. This comment could probably be deleted |
||
| } | ||
| columns := []table.Column{ | ||
| {Title: "Id", Width: 4}, | ||
| {Title: "Name", Width: 20}, | ||
| {Title: "Description", Width: 60}, | ||
| } | ||
|
|
||
| rows := make([]table.Row, 0) | ||
|
There was a problem hiding this comment. I guess the length 0 here could be more optimally set to |
||
|
|
||
| if m.registeredModelsList != nil { | ||
| for _, model := range m.registeredModelsList.Items { | ||
| rows = append( | ||
| rows, table.Row{ | ||
| model.GetId(), | ||
| model.GetName(), | ||
| model.GetDescription(), | ||
| }, | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| t := table.New( | ||
| table.WithColumns(columns), | ||
| table.WithRows(rows), | ||
| table.WithHeight(len(rows)+1), | ||
| ) | ||
|
|
||
| s := table.DefaultStyles() | ||
| s.Cell.Foreground(lipgloss.Color("#FFF")) | ||
| s.Header. | ||
| BorderStyle(lipgloss.NormalBorder()). | ||
| BorderForeground(lipgloss.Color("#04B575")). | ||
| BorderBottom(true). | ||
| Bold(true) | ||
| t.SetStyles(s) | ||
| t.SetCursor(m.cursor) | ||
| return baseStyle.Render(t.View()) + "\n" | ||
| } | ||
|
|
||
| // modelsCmd represents the models command | ||
| var modelsCmd = &cobra.Command{ | ||
| Use: "models", | ||
| Short: "Manage models", | ||
| Long: `Manage Open Data Hub models from the command line. | ||
|
|
||
| This command will list all the registered models available in the Open Data Hub model registry.`, | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| m, err := tea.NewProgram(model{}).Run() | ||
| if err != nil { | ||
| cmd.PrintErrf("Error: %v\n", err) | ||
| os.Exit(1) | ||
| } | ||
| if m.(model).err != nil { | ||
| // cmd.PrintErrf("Error: %v\n", m.(model).err) | ||
|
There was a problem hiding this comment. This commented code could probably be removed |
||
| os.Exit(1) | ||
| } | ||
| }, | ||
| } | ||
|
|
||
| func init() { | ||
| rootCmd.AddCommand(modelsCmd) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this copyright assignment correct? Just checking in case it's from some pre-existing default in your editor.