Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upkeep for gptstudio (2024) #164

Open
9 tasks done
JamesHWade opened this issue Jan 8, 2024 · 14 comments
Open
9 tasks done

Upkeep for gptstudio (2024) #164

JamesHWade opened this issue Jan 8, 2024 · 14 comments
Labels
upkeep maintenance, infrastructure, and similar

Comments

@JamesHWade
Copy link
Collaborator

JamesHWade commented Jan 8, 2024

  • usethis::use_tidy_description()
  • Align the names of R/ files and test/ files for workflow happiness. The docs for usethis::use_r() include a helpful script. usethis::rename_files() may be be useful.
  • Add alt-text to pictures, plots, etc; see https://posit.co/blog/knitr-fig-alt/ for examples

Set up or update GitHub Actions.
Updating workflows to the latest version will often fix troublesome actions:

  • usethis::use_github_action('check-standard')
  • usethis::use_github_action('pkgdown')
  • usethis::use_github_action('test-coverage')

Created on 2024-01-08 with usethis::use_upkeep_issue(), using usethis v2.2.2

  • Update home page examples to reflect new UIs
  • Create example for using local model
  • Update Google AI Studio to Gemini
@JamesHWade
Copy link
Collaborator Author

@calderonsamuel, I'm coming back from parental leave soon, and I want to give a lot more time to this package. Thought I'd start that off with an "upkeep" issue created with usethis::use_upkeep_issue().

Anything else you'd like to add? After this, it seems like a good time to issue a new release given all your fantastic recent contributions.

@JamesHWade
Copy link
Collaborator Author

#165

@calderonsamuel
Copy link
Collaborator

calderonsamuel commented Jan 9, 2024

Hi James, glad to have you back! I think we need to solve the bugs listed in issues and improve some documentation.

I would also like to have some features implemented before v0.4.0:

v0.5.0

Thinking a bit about the near future, I think we should aim to achieve two things:

  1. Migrate the build skeleton -> perform request -> translate response process to S7 to have explicit "type safety" and extendability. The S7 classes and generics necessary should live in another package, where they should be documented, so gptstudio can focus on improving the chatgpt addin and the others. I'm working on a draft for such package in calderonsamuel/skellm. This will also mean that, eventually, other packages can wrap new APIs and the gptstudio addins will find their methods without depending on them (e.g. I'm already drafting how we can do that for ollama in calderonsamuel/ollama.
  2. Improve testing tooling. Here we should focus on test coverage and testing on CI (at least the free services).

v1.0.0

At some point we should reach an actual stable version. I would like to have these features, they are both pretty challeging:

@JamesHWade
Copy link
Collaborator Author

Great ideas. I updated them to tasks for us to work on. Thanks again for all of you fantastic work on this package! I'm excited by your {skellm} package.

@JamesHWade JamesHWade added the upkeep maintenance, infrastructure, and similar label Jan 13, 2024
@JamesHWade JamesHWade mentioned this issue Jan 13, 2024
21 tasks
@JamesHWade
Copy link
Collaborator Author

@calderonsamuel, you might be interested in this PR from httr2:

r-lib/httr2#437

It might make our lives a lot easier in parsing JSON from streams.

@JamesHWade
Copy link
Collaborator Author

@calderonsamuel , I'd like to submit 0.4 to CRAN with in the next few weeks. Do you think you'll have time to work on some of the items you mention above over the newt couple of weeks?

If so, let me know what you plan to work on, and I'll try to cover any of the remaining tasks.

@calderonsamuel
Copy link
Collaborator

@calderonsamuel , I'd like to submit 0.4 to CRAN with in the next few weeks. Do you think you'll have time to work on some of the items you mention above over the newt couple of weeks?

If so, let me know what you plan to work on, and I'll try to cover any of the remaining tasks.

Hi James. I can focus on reducing the hard coded css and the dynamic model selection. Also I can help with fixing bug reports

@calderonsamuel
Copy link
Collaborator

Hey James, I think we should push v0.4.0 to CRAN and move the pending issues to v0.5.0. The current CRAN version crashes in different scenarios that have long been fixed in the develpment branch. Also, lots of newbies don't know how to install from github. Just give time to fix #202 and we should be good to go

@JamesHWade
Copy link
Collaborator Author

Let's do it. Is next week a good target?

@JamesHWade
Copy link
Collaborator Author

I'll plan to send this off to CRAN tomorrow unless I hear any objections. Excited to get this next version out there!!!

@calderonsamuel
Copy link
Collaborator

I'll just like your opinion on keeping the following elemets:

  1. Sidebar > Settings > "Save settings for this session"
  2. Sidebar > "Delete all chats"

They were useful for the development, but I'm not sure if final users will them useful too.

@JamesHWade
Copy link
Collaborator Author

I use them all the time, so I say keep them.

@calderonsamuel
Copy link
Collaborator

I have a lot of small updates in my mind, but I don't want us to lose the momentum. Lets go to CRAN

@JamesHWade
Copy link
Collaborator Author

I have it ready to submit Monday morning. I forgot they don't like submissions on the weekends.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
upkeep maintenance, infrastructure, and similar
Projects
None yet
Development

No branches or pull requests

2 participants