gonzalonunez / docc-gpt Goto Github PK

I ran DocC-GPT on a swift package I have called Animal Years. It is a very simple class with two methods. After running DocC-GPT on my package, it did add documentation text comments to the class and and the first method, but it clipped off the end of my first method, and completely deleted my second method.

Explore using Swift Syntax to document smaller units of code at a time instead of entire files. This would get us around some token limit issues, but I worry we may lose some of the contextual benefits of passing in entire files.

https://github.com/apple/swift-syntax

https://github.com/apple/swift-log

This would get us 100k context windows

Let's parallelize the script instead of documenting each file sequentially.

I just went to try this with the Swift Package Index Server repo and it throws the following error after processing what seems to be the last file in the list:

✓ Finished documenting BuildIndex+Model.swift
✓ Finished documenting BuildShow+View.swift
✓ Finished documenting BuildShow+Model.swift
✓ Finished documenting PackageResult+ModelSupport.swift
✓ Finished documenting PackageShow+StructuredDataSchema.swift
✓ Finished documenting PackageShow+Types.swift
✓ Finished documenting routes.swift
Error: keyNotFound(CodingKeys(stringValue: "choices", intValue: nil), Swift.DecodingError.Context(codingPath: [], debugDescription: "No value associated with key CodingKeys(stringValue: \"choices\", intValue: nil) (\"choices\").", underlyingError: nil))

I believe routes.swift is the last one, judging by the logs earlier in the list

᠅ Documenting PackageShow+StructuredDataSchema.swift...
᠅ Documenting PackageShow+Types.swift...
᠅ Documenting routes.swift...
✓ Finished documenting UpdateRecentPackages1.swift
✓ Finished documenting UpdateVersionAddUrl.swift
✓ Finished documenting UpdateVersionAddPublisedAtReleaseNotes.swift
✓ Finished documenting CreateTarget.swift

I wonder if this is due to API metering or something? I'm using the free plan at the moment, while playing around.

Might try this in a smaller project but if you've got a pointer, that'd be great :)

If the GPT-4 32k context window still leaves us wanting with a few-shot prompt, consider fine-tuning a base model with examples of well-documented Swift code.

https://platform.openai.com/

We can probably do something fancy Concurrency-wise together with counting tokens to get around this pretty easily