UI Overview + UI Chat with LLM #7

dominikkawka · 2024-10-04T12:13:24Z

Still have to write a section on skills/ knowledge contributions and being able to view them, would like some feedback on what I've currently written also.

vishnoianil · 2024-10-15T06:25:26Z

cc : @instructlab/ui-maintainers

vishnoianil

Thanks for the awesome work @dominikkawka . Review and provides minor review comments.

vishnoianil · 2024-10-15T07:25:23Z

docs/user-interface/env_oauth_config.md

+
+Set the `Homepage URL` and the `Authorization Callback URL` to `http://localhost:3000`.
+
+Update the .env files with the new ID and secret ID generated, `OAUTH_GITHUB_ID` = Client ID, `OAUTH_GITHUB_SECRET` = Client Secret


Creation of the OAuth App will create the client_id, that is set to OAUTH_GITHUB_ID, but it doesn't automatically create the secret. Once the app is created, on the main page it provides an option to create a secret. Press the Create Secret button and it will generate a secret for you. Copy the secret and set it to OAUTH_GITHUB_SECRET value.

If user don't want to setup the OAuth in his own org, we would recommend users to reach out to UI maintainers over the #ui slack channel and they will be happy to share the details of the dev OAuth app setup for the instructlab-public org for test-taxonomy.

vishnoianil · 2024-10-15T07:29:17Z

docs/user-interface/playground_chat.md

+
+![UI No Model Response](../images/user-interface/ui_no_model_response.png)
+
+However, the model won't reply because a granite/ merlinite model endpoint hasn't been given. Instead, we will create a new custom model endpoint, using our locally hosted quantised model from step 1.


@dominikkawka Focus of this document is dev environment or the direct users of ui.instructlab.ai? Details looks good for dev setup, but using the ui.instructlab.ai they can chat with both merlinite and granite models.

vishnoianil · 2024-10-15T07:30:52Z

docs/user-interface/playground_chat.md

+
+You will have 3 fields to fill out
+
+* The URL, where your customised model is hosted, which would be `http://127.0.0.1:8000/`


Assuming that the customized model is running where the UI is running. If it's running on different machine, it needs to be the reachable ip address of that machine. Port number should be the one where customize model serve is listening on.

vishnoianil · 2024-10-15T07:31:21Z

docs/user-interface/playground_chat.md

+
+* The Model Name, `merlinite-7b-lab-Q4_K_M.gguf`
+
+* API Key, you may put any text in here, in this case I've put in `randomCharacters`


Or if user is setting up an API key, they should provide the key here.

vishnoianil · 2024-10-15T07:36:35Z

docs/user-interface/skills_knowledge_contributions.md

+
+### Taxonomy Directory Path
+
+Specify where in the taxonomy this skill would belong in. As the taxonomy fills, it will become more complex, make sure to give a concise location to keep the taxonomy organised.


Suggested change

Specify where in the taxonomy this skill would belong in. As the taxonomy fills, it will become more complex, make sure to give a concise location to keep the taxonomy organised.

Specify where in the taxonomy repository directory structure this skill would belong in. As the taxonomy fills in with more skills, it will become more complex, make sure to give a concise location to keep the taxonomy organised.

vishnoianil · 2024-10-15T07:44:38Z

docs/user-interface/skills_knowledge_contributions.md

+![Forked Repository Showcase](../images//user-interface/ui_knowledge_repo_created.png)
+
+If you've already uploaded the markdown file to your github, you can switch to manually adding the document, and entering the `commit sha`.
+


I think it would be helpful if we add the snapshot of the Manually adding the doc details page.

vishnoianil · 2024-10-15T07:45:37Z

docs/user-interface/ui_overview.md

+
+The InstructLab User Interface (UI) is an additional component in the InstructLab project to make Knowledge/Skills 
+contributions more accessible to the general user. Instead of having to edit a `qna.yaml` file,
+users can fill out the contribution forms on the web. The user can also view their all of their contributions in a


Suggested change

users can fill out the contribution forms on the web. The user can also view their all of their contributions in a

users can fill out the contribution forms on the web. The user can also view all of their contributions in a

vishnoianil · 2024-10-15T07:47:19Z

docs/user-interface/ui_overview.md

+!!! note
+    To log into the UI and submit Knowledge and Skills contributions, you must be a member of the [instructlab-public](https://github.com/instructlab-public) github repository.
+
+    If you aren't a member of the repository, but still wish to experiment with the UI, we recommend you to download it locally.


I think we should recommend users to reach out to UI maintainers to add them to the instructlab-public org. If they don't want to join but still want to experiment, they can set it up locally.

vishnoianil · 2024-10-15T07:48:06Z

docs/user-interface/ui_overview.md

+
+* Have a [github](https://github.com/) account
+
+* Have InstructLab installed 


This is not a mandatory requirement. This is needed only if user wants to host the endpoint locally on the same machine.

vishnoianil · 2024-10-15T07:50:21Z

docs/user-interface/ui_overview.md

+
+When the install is finished, start the UI by running:
+
+`make start-dev-local` 


I think we should mention how to stop the ui as well. User can use command make stop-dev-local to stop the dev environment.

Signed-off-by: DominikKawka <dkawka@redhat.com>

jjasghar · 2024-10-16T13:05:12Z

I just did a flip through, this is amazing work Dom, great job.

kelbrown20 · 2024-11-11T19:40:37Z

Im not an expert on the UI, but on the docs side this looks awesome to me! Great work! I think we should get this merged soon whenever its ready! 🍾

vishnoianil · 2024-11-12T07:05:54Z

I dropped the ball on reviewing it again, but the content looks great!. Thanks for pulling this together @dominikkawka . I pushed a PR to UI repo as well, that points to this brand new documentation. Awesome work, you rock !!

dominikkawka force-pushed the ui branch from fce4f64 to 7d21eaa Compare October 4, 2024 12:16

dominikkawka force-pushed the ui branch from 98b0314 to a2c868f Compare October 11, 2024 13:38

dominikkawka marked this pull request as ready for review October 11, 2024 13:42

dominikkawka mentioned this pull request Oct 11, 2024

Write a getting started document for users to navigate through the UI instructlab/ui#249

Open

vishnoianil self-requested a review October 15, 2024 06:24

vishnoianil reviewed Oct 15, 2024

View reviewed changes

dominikkawka force-pushed the ui branch 3 times, most recently from ce4f68b to ea334c4 Compare October 16, 2024 12:00

dominikkawka added 6 commits October 16, 2024 13:11

UI Overview + UI Chat with LLM

7eabcd4

Signed-off-by: DominikKawka <dkawka@redhat.com>

UI Skills/Knowledge Contribution + .env & OAuth config

87ede66

Signed-off-by: DominikKawka <dkawka@redhat.com>

ui documentation iteration

9ebedea

Signed-off-by: DominikKawka <dkawka@redhat.com>

added contributions workshop/ guide by @mingxzhao

b666389

Signed-off-by: DominikKawka <dkawka@redhat.com>

fixed hyperlink directory

b115838

Signed-off-by: DominikKawka <dkawka@redhat.com>

minor document structure change

220d981

Signed-off-by: DominikKawka <dkawka@redhat.com>

dominikkawka force-pushed the ui branch from d7831e0 to 220d981 Compare October 16, 2024 12:12

jjasghar approved these changes Nov 11, 2024

View reviewed changes

jjasghar merged commit 6174543 into instructlab:main Nov 11, 2024
1 check passed

dominikkawka deleted the ui branch April 14, 2025 12:59


		Set the `Homepage URL` and the `Authorization Callback URL` to `http://localhost:3000`.

		Update the .env files with the new ID and secret ID generated, `OAUTH_GITHUB_ID` = Client ID, `OAUTH_GITHUB_SECRET` = Client Secret No newline at end of file


		![UI No Model Response](../images/user-interface/ui_no_model_response.png)

		However, the model won't reply because a granite/ merlinite model endpoint hasn't been given. Instead, we will create a new custom model endpoint, using our locally hosted quantised model from step 1.


		You will have 3 fields to fill out

		* The URL, where your customised model is hosted, which would be `http://127.0.0.1:8000/`


		* The Model Name, `merlinite-7b-lab-Q4_K_M.gguf`

		* API Key, you may put any text in here, in this case I've put in `randomCharacters`


		### Taxonomy Directory Path

		Specify where in the taxonomy this skill would belong in. As the taxonomy fills, it will become more complex, make sure to give a concise location to keep the taxonomy organised.

	Specify where in the taxonomy this skill would belong in. As the taxonomy fills, it will become more complex, make sure to give a concise location to keep the taxonomy organised.
	Specify where in the taxonomy repository directory structure this skill would belong in. As the taxonomy fills in with more skills, it will become more complex, make sure to give a concise location to keep the taxonomy organised.

		![Forked Repository Showcase](../images//user-interface/ui_knowledge_repo_created.png)

		If you've already uploaded the markdown file to your github, you can switch to manually adding the document, and entering the `commit sha`.

	users can fill out the contribution forms on the web. The user can also view their all of their contributions in a
	users can fill out the contribution forms on the web. The user can also view all of their contributions in a


		* Have a [github](https://github.com/) account

		* Have InstructLab installed


		When the install is finished, start the UI by running:

		`make start-dev-local`

UI Overview + UI Chat with LLM #7

UI Overview + UI Chat with LLM #7

Uh oh!

Conversation

dominikkawka commented Oct 4, 2024

Uh oh!

vishnoianil commented Oct 15, 2024

Uh oh!

vishnoianil left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jjasghar commented Oct 16, 2024

Uh oh!

kelbrown20 commented Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

vishnoianil commented Nov 12, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kelbrown20 commented Nov 11, 2024 •

edited

Loading