以下是已提议在 Julia 语言旗帜下进行 Google Season of Docs 的项目。如果您对潜在项目有任何疑问,请联系项目中列出的导师。如果您无法联系到潜在导师,请发送电子邮件至 [email protected]
并抄送 [email protected]
。
Julia 语言团队致力于使每个人都能参与 Google Season of Docs 的申请流程和参与 Julia 项目。如果您有任何问题或请求,请随时联系我们,我们将尽力满足您的需求。
从我们的一位技术作家那里了解他们在 GSoD 中的经历
以下是潜在 GSoD 项目的持续列表。如果您对其中任何项目感兴趣,请联系相应的导师。
[!Note]
在本节中,请用几段简短的文字介绍您的组织或项目。您的项目解决了什么问题?您的用户和贡献者是谁?您的组织或项目存在了多久?提供一些背景信息,帮助我们了解为什么资助您的提案将对开源和世界产生积极影响。
Julia 编程语言是一种获得 MIT 许可的高性能编程语言,专为科学计算和通用计算中的速度、可用性和可重复性而设计。目前,Julia 社区拥有超过 7,000 个注册的 Julia 包,3500 万次以上的 Julia 下载量,以及来自世界各地的数千名贡献者。由于用户和开发者的积极贡献,Julia 的受欢迎程度不断提高,他们帮助在 Julia 中开发了多个较小的专业生态系统。
特别是,JuliaHealth 组织 就是这样一个生态系统,最初于 2020 年组建成立。它是一个致力于通过开发用于处理各种健康数据的开源工具来改善医疗保健的组织,并在更广泛的健康研究社区中推广可互操作的数据标准。该社区由热衷于使用 Julia 研究和改善患者预后,并促进数据驱动的决策的健康研究人员、数据科学家、软件开发人员和医疗保健专业人士组成。
在过去的四年里,我们的组织成员人数已增至 60 多人,他们积极参与我们拥有的几十个 JuliaHealth 包的开发。随着整个 JuliaHealth 用户社区在 Julia Slack 和 Julia Zulip 实例上拥有超过 250 名注册用户,JuliaHealth 旗下已经自然形成了利基子生态系统。目前,有各种子生态系统,例如医学成像和观察性健康子生态系统,并且更多子生态系统开始出现。
[!Note]
告诉我们您的项目将帮助解决什么问题。解决这个问题对您的组织或项目来说为什么很重要?
随着 JuliaHealth 这些年来取得了巨大的发展 - 用户、成员和积极维护的包都大幅增长 - 我们开始看到对更统一文档的需求。没有这种统一的文档,我们看到
由于缺乏关于子生态系统(包括新兴和已建立的子生态系统)的文档,用户感到困惑
不同包之间文档的碎片化发展
缺乏用户和开发人员如何组合 JuliaHealth 和更广泛的 Julia 生态系统中的包以完成研究任务的清晰度
从某种程度上说,这是一个非常好的局面,因为我们已经发展到出现这些问题的程度。用户和开发人员希望参与 JuliaHealth 社区,但如果我们不提供更统一的文档方法,我们可能会失去成员或新贡献者,并且我们的发展停滞不前。
通过提供更清晰的指导并提高可访问性,我们希望使浏览 JuliaHealth 组织的不同方面变得无缝且直观。
我们设想,通过参与 GSoD,通过开发增强和统一的文档,我们可以帮助 JuliaHealth 生态系统中的所有社区层级。
此外,当我们在 JuliaHealth 中构建解决方案来解决我们作为成长型组织遇到的需求时,我们将与更广泛的 Julia 社区分享我们的见解,以说明 Julia 中其他生态系统可以采用哪些方法来满足不断增长的需求。
[!Note]
告诉我们您的组织将创建、更新或改进哪些文档。如果某些工作故意不做,请将该信息也包括在内。包括时间估计,以及您是否已经确定了组织志愿者和技术作家来参与您的项目。
虽然 JuliaHealth 中有许多子生态系统,但我们的项目范围将专门针对医学成像子生态系统,因为它已经发展成熟到足以遇到许多这些问题。围绕医学成像子生态系统进行文档工作将使整个 JuliaHealth 生态系统受益,因为它将提供一个路线图,说明其他子生态系统如何最好地记录自己并支持其用户。
为了更好地将医学成像子生态系统定位在 JuliaHealth 组织中,我们首先需要对 JuliaHealth 主网站进行一些常规的文档改进。这包括
将网站升级到最新的 Julia 文档部署工具
DocumenterVitepress.jl 可能是一个目标
添加 JuliaHealth 的更多组织详细信息,包括
子生态系统的全新主页
医学成像
观察性健康
标准和互操作性
使用我们现有的包列表工具进行包分解
添加常见问题解答或支持页面
定义并实施跟踪指标以监控用户参与和与平台的交互
使用 GoatCounter 等开源且符合 GDPR 的技术
完成这些初步工作后,我们将解决医学成像子生态系统中的一些特定核心工具。由于该子生态系统中包的模块化特性,我们需要改进不同包的文档,以说明它们的使用目的、它们如何相互集成以及如何成为潜在的新贡献者
文档任务针对 MedImage
介绍医学成像格式和空间元数据的理论
描述如何加载和保存图像
描述如何使用 MedImage 应用基本转换
文档任务针对 MedEye3d
编写教程,说明如何配置窗口大小和分配给文本的空间量
提供详细的教程,描述使用 TextureSpec 对象的可能配置
添加包含所有键盘快捷键和打印屏幕的章节,显示其效果
描述可能的用户交互,包括
使用 REPL 进行快速调试,包括如何手动修改和刷新图像
描述可修改掩码的手动交互
文档任务针对 MedEval3D
描述不同的指标及其优缺点
制作教程,展示如何使用每个指标
文档任务针对 MedPipe3D
描述如何在不同的用例中使用 Medpipe 功能
介绍正在开发中的功能,如增强、最大连通分量分析或超参数调整(不含使用示例)
文档任务针对 KomaMRI
通过与 KomaMRI 志愿者的协调,将解决 KomaMRI 中的未解决问题
最后,如果有时间,我们将尝试实现一些额外的延伸目标
JuliaHealth 中正在进行的项目的页面
JuliaHealth 中研究成果的页面
在 Medeye 主题上撰写一篇 JuliaHealth 博客文章,以扩大项目的影响范围
姓名:Sneha Pandey
Sneha Pandey 是一名专注于 AI 和 ML 的二年级学生,也是微软学习学生大使。通过这个角色,她磨练了有效地将复杂概念传达给不同受众的能力。此外,她还积累了内容作家的经验,为她的大学创作内容。她拥有使用 Streamlit 和 Python 开发各种小型项目的实际经验,例如 WhatsApp 机器人和 ML 脚本模型。她对 Julia 的熟悉来自于之前与 MD PhD Msc Jakub Mitura 在医学成像方面的合作。此外,她使用 Documenter.jl 对她的个人项目进行了全面的文档记录。这些经验共同为她在 Julia 生态系统中成为一名技术作家提供了必要的技能和能力。
志愿者 1:一般 JuliaHealth 组织志愿者
姓名:Jacob S. Zelko
职责
为一般 JuliaHealth 文档任务提供支持。
定期协助审查文档拉取请求 (PR)。
根据需要在 Julia 生态系统中部署文档。
处理出现的各种任务。
在将技术作家的工作整合到更广泛的 JuliaHealth 生态系统时,担任一般支持角色。
志愿者 2:JuliaDocs 和文档部署志愿者
姓名:Anshul Singhvi
职责
将 JuliaHealth 主页迁移到指定的技术平台。
为安全实施跟踪指标以监控用户参与和与平台的交互提供指导。
在整个项目持续时间内提供必要的技术咨询和指导。
帮助解决使用 JuliaDocs 生态系统中的工具可能出现的任何问题或需求
志愿者 3:医学成像子生态系统志愿者
姓名:Guillermo Sahonero Alvarez
职责
为医学成像理论和空间元数据提供指导
支持将成像讨论与 Julia 生态系统的其他方面(如 MLJ 或 JuliaImages)联系起来
为成像标准提供主题专业知识
协助撰写理论介绍
志愿者 4:包功能和函数文档任务咨询
职责
与技术作家合作,解决 Julia 编程语言的实际开发问题
帮助检查函数的文档字符串是否正常工作
与 KormaMRI 合作,根据他们的研究论文创建专门的文档部分,涵盖与医学成像相关的先进主题或技术。
为了明确列出超出本项目范围的工作,我们不打算在以下方面进行工作
为其他子生态系统开发完整的文档
与文档无关的任何上述医学成像包
根据任务需求,添加文档字符串或交叉链接可能属于项目范围
[!Note]
您如何知道新的文档帮助您解决了问题?您将使用哪些指标,以及如何跟踪它们?
目前,我们现有的文档尚不支持文档流量分析。截至目前,我们最好的直接流量指标来源是使用JuliaHub监控软件包下载量,并参考GitHub星标来粗略估计“可发现性”。此外,我们利用Julia编程语言YouTube频道来监控对我们录制JuliaHealth工作组会议的参与度。在这些情况下,潜在用户或贡献者必须知道在哪里寻找这些资源或进入我们支持的软件包及其各自子生态系统的入口点。
对于JuliaHealth,如果我们
能够方便地跟踪跨软件包的文档流量
包含部署一个安全的流量检测工具
在部署跟踪后,看到至少 10%-15% 的流量增长
所有JuliaHealth平台的流量总体增长 5%-10%
包括JuliaHub、YouTube、GitHub和文档统计数据
大多数(如果不是全部)列出的文档任务已完成,用于医学影像子生态系统
一些相关问题链接
子软件包文档 1 子软件包文档 2 子软件包文档 3 子软件包文档 4
在整个JuliaHealth生态系统中至少有 3-5 名新的活跃JuliaHealth贡献者加入
跟踪GitHub贡献历史
发布一篇新的博客文章
[!Note]
您估计这项工作需要多长时间?您能按月/周分解技术作家任务吗?
我们假设技术作家在此期间将投入兼职时间(每周 10-20 小时)。
日期 | 行动项目 |
---|---|
五月 | 技术作家和志愿者招聘,入职 |
六月-七月 | 研究Julia社区,审核现有文档 |
八月-九月 | 创建标准软件包文档,医学影像子生态系统文档 |
十月 | 改进JuliaHealth主页面 |
十一月 | 撰写博客文章,任何未完成的任务或扩展目标 |
第 1-2 周 - 阅读和熟悉
第 3-4 周 - 文档流量跟踪器设置
第 5-7 周 - 设置环境并更新组织详细信息 & 创建子生态系统部分
第 8-10 周 - 链接跨子生态系统的软件包
第 11-16 周 - 医学影像子生态系统软件包文档
第 17-20 周 - 审查和完成网站内容,并纳入反馈
第 20-24 周 - 完成/修饰所有软件包文档页面,以及扩展目标
该时间线基本上是准确的,但我们预计不同的软件包或任务可能比其他任务更具挑战性。十一月的时间段使我们有机会重新审视任何未完成的任务,并有可能探索扩展目标,如果当时没有太多未完成的任务。
我们将使用的主要沟通渠道是Julia Slack, Jakub Mitura 博士(医学博士,哲学博士)将负责整个项目的联系和指导,以便定期更新和会议。在Slack之外,电子邮件将用于处理与GSoD组织者和管理员的沟通,Jakub Mitura的电子邮件地址为:[email protected]。志愿者也将根据需要在Slack上提供沟通服务。此外,项目更新将通过Julia Health Slack频道发布,该频道是JuliaHealth成员、用户和Julia社区其他成员之间进行大部分沟通的地方。
[!Note]
您可以在提案中或作为单独的链接包含您的预算。如果您的预算少于十项,我们建议您将其包含在您的提案中。
预算项目 | 金额 | 累计总额 |
---|---|---|
技术作家 | $4000 | $4000 |
志愿者(500 x 4) | $2000 | $6000 |
礼品(3件T恤和10包贴纸) | $125 | $6125 |
总计 | $6125 |
其他理由
志愿者:请参阅上面关于项目范围部分的有关选定志愿者的详细信息。
礼品:是为了为我们的作家和志愿者创造更友好的环境。
贴纸包也将被赠送给新贡献者。
[!Note]
除了以上提案信息之外,还有一些关于该项目团队组成的一些补充说明。
关于GSoD项目负责人
医学博士,哲学博士,理学硕士 Jakub Mitura 是一位专注于创建用于医学影像的人工智能模型的研究人员。拥有医学科学博士学位,论文题目为“使用氟脱氧葡萄糖进行正电子发射断层扫描在血管假体感染诊断中的作用”。此外,还拥有信息学硕士学位,专门从事大数据。在医学和人工智能领域发表过科学出版物。
其他志愿者说明
Jacob Zelko 被选为志愿者,因为他拥有过去 3 年成功的 Google Summer of Code 导师的成功记录,并且目前是今年 Google Summer of Code 的 Julia 组织的联合管理员,负责处理来自学生和导师的疑问。鉴于他的经验,Jacob 将根据需要为 Jakub 和 Sneha 提供指导,以确保该项目与 Google 开源计划的一般目标保持一致。此外,Jacob 过去通过 Google Summer of Code 和佐治亚理工学院研究所以及疾病控制与预防中心的先前职位监督了许多赠款,他将成为回答有关项目范围的任何问题的宝贵资产。
Anshul Singhvi 是一位前 Google Summer of Code 学生,并且在整个 Julia 生态系统中拥有丰富的经验。特别是,Anshul 是众多 Julia 组织的成员,他将成为一项宝贵的资产,不仅可以了解文档部署的最佳实践,还可以帮助将 JuliaHealth 软件包统一到 JuliaHealth 本身以及更大的 Julia 环境中。他的见解对于减少任何重复工作或回答未解决的问题至关重要,以确保该项目尽可能有效地运行。此外,鉴于 Anshul 在交付合同工作方面拥有丰富的经验,他将成为确保我们在最终报告的案例研究中调查和报告的指标将严格进行,并尽最大努力利用我们可获得的数据。
</div>