Summer of Code - Getting Started: Difference between revisions

m
update year - edit link this time
(→‎Suggested projects: add Chebfun project)
m (update year - edit link this time)
 
(17 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Note|GNU Octave is a [https://summerofcode.withgoogle.com/programs/2023/organizations/gnu-octave mentoring organization for GSoC 2023].}}
{{Note|GNU Octave is a [https://summerofcode.withgoogle.com/programs/2025/organizations/gnu-octave mentoring organization for GSoC 2025].}}


Since 2011 the GNU Octave project has successfully mentored:
Since 2011 the GNU Octave project has successfully mentored:
Line 27: Line 27:
#* Try to show us as early as possible a draft of your proposal 📑
#* Try to show us as early as possible a draft of your proposal 📑
#* If we see your proposal for the first time after the application deadline, it might easily contain some paragraphs not fully clear to us.  Ongoing interaction will give us more confidence that you are capable of working on your project 🙂👍
#* If we see your proposal for the first time after the application deadline, it might easily contain some paragraphs not fully clear to us.  Ongoing interaction will give us more confidence that you are capable of working on your project 🙂👍
#* Here’s a sample proposal outline that you can use as a reference when drafting your own application. [https://docs.google.com/document/d/1kGtT9_f0FrXdCKwyKEWwOV6R-AU90bkd/edit?usp=sharing&ouid=115736651221450989198&rtpof=true&sd=true Sample Proposal]
#* Then submit the proposal following the applicable rules, e.g. for [https://google.github.io/gsocguides/student/writing-a-proposal GSoC]. 📨
#* Then submit the proposal following the applicable rules, e.g. for [https://google.github.io/gsocguides/student/writing-a-proposal GSoC]. 📨


Line 56: Line 57:
= Suggested projects =
= Suggested projects =


The following suggested projects are distilled from the [[Projects]] page for the benefit of potential SoC participants.  You can also look at our [[Summer of Code|completed past projects]], or the current [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/ROADMAP.md| Octave Development Roadmap] for more inspiration.
The following suggested projects are distilled from the [[Projects]] page for the benefit of potential SoC participants.  You can also look at our [[Summer of Code|completed past projects]], or the current [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/ROADMAP.md | Octave Development Roadmap] for more inspiration.


{{Note|Do you use Octave at your working place or university? Do you have some numerical project in mind?  You are always welcome to '''propose your own projects'''.  If you are passionate about your project, it will be easy to find an Octave developer to mentor and guide you. Please note that for such a proposal to be successful it will almost certainly involve initiating pre-proposal discussion over at the [https://octave.discourse.group Octave Discourse forum].}}
{{Note|Do you use Octave at your working place or university? Do you have some numerical project in mind?  You are always welcome to '''propose your own projects'''.  If you are passionate about your project, it will be easy to find an Octave developer to mentor and guide you. Please note that for such a proposal to be successful it will almost certainly involve initiating pre-proposal discussion over at the [https://octave.discourse.group Octave Discourse forum].}}


== Adding more Classification classes and implementing missing methods in statistics package ==
== Adding clustering {{Codeline|*Searcher}} classes in statistics package ==


Although a ClassificationKNN class was added in the latest statistics release (1.6.1), it still lacks several methods (only `predict` is available at the moment). This GSoC project aims at implementing more methods, such as crossval, cvloss, lime, loss, margin, partialDependence, plotPartialDependence, etc., as well as adding more classdefs related to classification classes, such as ClassificationGAM, ClassificationDiscriminant, ClassificationSVM, ClassificationNeuralNetwork, ClassificationNaiveBayes, etc. The statistics package, although heavily developed during the past years, still lacks a lot of classdef functionality. The scope is to implement classification class def objects and their relevant methods in a MATLAB compatible way.  
Although the statistics package already has {{Codeline|knnsearch}} and {{Codeline|rangesearch}} functions, it misses [https://docs.octave.org/latest/Creating-a-classdef-Class.html classdefs] for extending their functionality. Furthermore, the {{Codeline|KDTree}} method in the aforementioned functions is currently disabled, because it is very slow and poorly implemented (see GitHub issue [https://github.com/gnu-octave/statistics/issues/151 #151]). The goal of this project if to implement {{Codeline|KDTreeSearcher}}, {{Codeline|ExhaustiveSearcher}}, and {{Codeline|hnswSearcher}} classes (including their {{Codeline|knnsearch}} and {{Codeline|rangesearch}} methods) along with the {{Codeline|createns}} helper function. Beyond MATLAB compatibility, the KDTree implementation should ideally utilize a compiled oct library for faster construction and queries of points.


* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours (hard)
: ~350 hours (hard)
* '''Required skills'''
* '''Required skills'''
: Octave, classdef, good knowledge of statistical methods
: Octave, classdef, C++, good knowledge of clustering methods
* '''Potential mentors'''
* '''Potential mentors'''
: [https://octave.discourse.group/u/pr0m1th3as Andreas Bertsatos]
: [https://octave.discourse.group/u/pr0m1th3as Andreas Bertsatos]
Line 83: Line 84:




== Port Chebfun to Octave and Improve Classdef support in Octave by porting Chebfun ==
== Port Chebfun to Octave and improve classdef support ==


[https://www.chebfun.org| Chebfun] uses interpolation to approximate functions to very high accuracy, giving numerical computing that feels like symbolic computing.
[https://www.chebfun.org| Chebfun] uses interpolation to approximate functions to very high accuracy, giving numerical computing that feels like symbolic computing.
Line 90: Line 91:
This project has two aims: (1) make changes to the Chebfun code to make it work on Octave and (2) improve Octave's classdef functionality.
This project has two aims: (1) make changes to the Chebfun code to make it work on Octave and (2) improve Octave's classdef functionality.
Some initial steps toward to first goal can be found on [https://github.com/cbm755/chebfun/tree/octave_dev| this octave_dev branch].
Some initial steps toward to first goal can be found on [https://github.com/cbm755/chebfun/tree/octave_dev| this octave_dev branch].
The second goal will likely involve a collaborative effort because classdef is a priority on [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/ROADMAP.md| Octave's Development Roadmap] and because other proposed projects also involve classdef.
The second goal will likely involve a collaborative effort because classdef is a priority on [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/ROADMAP.md | Octave's Development Roadmap] and because other proposed projects also involve classdef.
   
   
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
Line 226: Line 227:
= Project sizes =
= Project sizes =


Since GSoC 2022 there exist two project sizes<ref>https://groups.google.com/g/google-summer-of-code-announce/c/_ekorpcglB8</ref><ref>https://google.github.io/gsocguides/mentor/defining-a-project-ideas-list</ref>:
As of 2024, possible project sizes are 90 (small), 175 (medium), or 350 hours (large) <ref>https://developers.google.com/open-source/gsoc/faq#how_much_time_does_gsoc_participation_take</ref>.
* '''~175 hours''' (~12 weeks, Jun 13 - Sept 12)
* '''~350 hours''' (~22 weeks, Jun 13 - Nov 21)


= Footnotes =
= Footnotes =
164

edits