README Roadmap and Intended PR Schedule#10
Open
etontackett wants to merge 40 commits into
Open
Conversation
vp314
requested changes
Jun 19, 2026
vp314
left a comment
vp314
left a comment
Owner
There was a problem hiding this comment.
Please think through what the file structure should look like. In the PR section, each PR should be its own subsection and there should be a table indicating what functionality/files are being implemented, their purpose, etc.
Comment on lines
+17
to
+44
| src/ | ||
| RidgeRegression.jl | ||
|
|
||
| algorithms/ | ||
| bidiagonalization.jl | ||
| closed_form.jl | ||
| gradient_descent.jl | ||
| stochastic_gradient_descent.jl | ||
|
|
||
| datasets.jl | ||
| design.jl | ||
|
|
||
| test/ | ||
| runtests.jl | ||
|
|
||
| dataset_tests.jl | ||
| design_tests.jl | ||
| bidiagonalization_tests.jl | ||
| closed_form_tests.jl | ||
| gradient_descent_tests.jl | ||
| stochastic_gradient_descent_tests.jl | ||
|
|
||
| docs/ | ||
| src/ | ||
| index.md | ||
| design.md | ||
| api.md | ||
| ``` |
Owner
There was a problem hiding this comment.
Use vertical bars and dashes to ensure spacing is correct
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add project roadmap and anticipated pull request schedule to README
Description
This PR updates the README with a project roadmap which includes:
-Intended source code structure and organization
-Planned development sequence
-An expected PR schedule for future work
Motivation and Context
The goal of this PR is to make the project structure and development plan clear for contributors and reviewers.
Types of changes
Checklists:
Code and Comments
If this PR includes modifications to the code base, please select all that apply.
API Documentation
Manual Documentation
Testing
@code_lowered and
@code_typed)