@wentorai/research-plugins 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -22
- package/curated/analysis/README.md +82 -56
- package/curated/domains/README.md +225 -69
- package/curated/literature/README.md +115 -46
- package/curated/research/README.md +106 -58
- package/curated/tools/README.md +107 -87
- package/curated/writing/README.md +92 -45
- package/mcp-configs/academic-db/alphafold-mcp.json +20 -0
- package/mcp-configs/academic-db/brightspace-mcp.json +21 -0
- package/mcp-configs/academic-db/climatiq-mcp.json +20 -0
- package/mcp-configs/academic-db/gibs-mcp.json +20 -0
- package/mcp-configs/academic-db/gis-mcp-server.json +22 -0
- package/mcp-configs/academic-db/google-earth-engine-mcp.json +21 -0
- package/mcp-configs/academic-db/m4-clinical-mcp.json +21 -0
- package/mcp-configs/academic-db/medical-mcp.json +21 -0
- package/mcp-configs/academic-db/nexonco-mcp.json +20 -0
- package/mcp-configs/academic-db/omop-mcp.json +20 -0
- package/mcp-configs/academic-db/onekgpd-mcp.json +20 -0
- package/mcp-configs/academic-db/openedu-mcp.json +20 -0
- package/mcp-configs/academic-db/opengenes-mcp.json +20 -0
- package/mcp-configs/academic-db/openstax-mcp.json +21 -0
- package/mcp-configs/academic-db/openstreetmap-mcp.json +21 -0
- package/mcp-configs/academic-db/opentargets-mcp.json +21 -0
- package/mcp-configs/academic-db/pdb-mcp.json +21 -0
- package/mcp-configs/academic-db/smithsonian-mcp.json +20 -0
- package/mcp-configs/ai-platform/magi-researchers.json +21 -0
- package/mcp-configs/ai-platform/mcp-academic-researcher.json +22 -0
- package/mcp-configs/ai-platform/open-paper-machine.json +21 -0
- package/mcp-configs/ai-platform/paper-intelligence.json +21 -0
- package/mcp-configs/ai-platform/paper-reader.json +21 -0
- package/mcp-configs/ai-platform/paperdebugger.json +21 -0
- package/mcp-configs/browser/exa-mcp.json +20 -0
- package/mcp-configs/browser/mcp-searxng.json +21 -0
- package/mcp-configs/browser/mcp-webresearch.json +20 -0
- package/mcp-configs/cloud-docs/confluence-mcp.json +37 -0
- package/mcp-configs/cloud-docs/google-drive-mcp.json +35 -0
- package/mcp-configs/cloud-docs/notion-mcp.json +29 -0
- package/mcp-configs/communication/discord-mcp.json +29 -0
- package/mcp-configs/communication/discourse-mcp.json +21 -0
- package/mcp-configs/communication/slack-mcp.json +29 -0
- package/mcp-configs/communication/telegram-mcp.json +28 -0
- package/mcp-configs/data-platform/automl-stat-mcp.json +21 -0
- package/mcp-configs/data-platform/jefferson-stats-mcp.json +22 -0
- package/mcp-configs/data-platform/mcp-excel-server.json +21 -0
- package/mcp-configs/data-platform/mcp-stata.json +21 -0
- package/mcp-configs/data-platform/mcpstack-jupyter.json +21 -0
- package/mcp-configs/data-platform/ml-mcp.json +21 -0
- package/mcp-configs/data-platform/nasdaq-data-link-mcp.json +20 -0
- package/mcp-configs/data-platform/numpy-mcp.json +21 -0
- package/mcp-configs/database/neo4j-mcp.json +37 -0
- package/mcp-configs/database/postgres-mcp.json +28 -0
- package/mcp-configs/database/sqlite-mcp.json +29 -0
- package/mcp-configs/dev-platform/geogebra-mcp.json +21 -0
- package/mcp-configs/dev-platform/github-mcp.json +31 -0
- package/mcp-configs/dev-platform/gitlab-mcp.json +34 -0
- package/mcp-configs/dev-platform/latex-mcp-server.json +21 -0
- package/mcp-configs/dev-platform/manim-mcp.json +20 -0
- package/mcp-configs/dev-platform/mcp-echarts.json +20 -0
- package/mcp-configs/dev-platform/panel-viz-mcp.json +20 -0
- package/mcp-configs/dev-platform/paperbanana.json +20 -0
- package/mcp-configs/dev-platform/texflow-mcp.json +20 -0
- package/mcp-configs/dev-platform/texmcp.json +20 -0
- package/mcp-configs/dev-platform/typst-mcp.json +21 -0
- package/mcp-configs/dev-platform/vizro-mcp.json +20 -0
- package/mcp-configs/email/email-mcp.json +40 -0
- package/mcp-configs/email/gmail-mcp.json +37 -0
- package/mcp-configs/note-knowledge/local-faiss-mcp.json +21 -0
- package/mcp-configs/note-knowledge/mcp-memory-service.json +21 -0
- package/mcp-configs/note-knowledge/mcp-obsidian.json +23 -0
- package/mcp-configs/note-knowledge/mcp-ragdocs.json +20 -0
- package/mcp-configs/note-knowledge/mcp-summarizer.json +21 -0
- package/mcp-configs/note-knowledge/mediawiki-mcp.json +21 -0
- package/mcp-configs/note-knowledge/openzim-mcp.json +20 -0
- package/mcp-configs/note-knowledge/zettelkasten-mcp.json +21 -0
- package/mcp-configs/reference-mgr/academic-paper-mcp-http.json +20 -0
- package/mcp-configs/reference-mgr/academix.json +20 -0
- package/mcp-configs/reference-mgr/arxiv-research-mcp.json +21 -0
- package/mcp-configs/reference-mgr/google-scholar-abstract-mcp.json +19 -0
- package/mcp-configs/reference-mgr/google-scholar-mcp.json +20 -0
- package/mcp-configs/reference-mgr/mcp-paperswithcode.json +21 -0
- package/mcp-configs/reference-mgr/mcp-scholarly.json +20 -0
- package/mcp-configs/reference-mgr/mcp-simple-arxiv.json +20 -0
- package/mcp-configs/reference-mgr/mcp-simple-pubmed.json +20 -0
- package/mcp-configs/reference-mgr/mcp-zotero.json +21 -0
- package/mcp-configs/reference-mgr/mendeley-mcp.json +20 -0
- package/mcp-configs/reference-mgr/ncbi-mcp-server.json +22 -0
- package/mcp-configs/reference-mgr/onecite.json +21 -0
- package/mcp-configs/reference-mgr/paper-search-mcp.json +21 -0
- package/mcp-configs/reference-mgr/pubmed-search-mcp.json +21 -0
- package/mcp-configs/reference-mgr/scholar-mcp.json +21 -0
- package/mcp-configs/reference-mgr/scholar-multi-mcp.json +21 -0
- package/mcp-configs/reference-mgr/seerai.json +21 -0
- package/mcp-configs/reference-mgr/semantic-scholar-fastmcp.json +21 -0
- package/mcp-configs/reference-mgr/sourcelibrary.json +20 -0
- package/mcp-configs/registry.json +178 -149
- package/mcp-configs/repository/dataverse-mcp.json +33 -0
- package/mcp-configs/repository/huggingface-mcp.json +29 -0
- package/openclaw.plugin.json +2 -2
- package/package.json +2 -2
- package/skills/analysis/dataviz/algorithm-visualizer-guide/SKILL.md +259 -0
- package/skills/analysis/dataviz/bokeh-visualization-guide/SKILL.md +270 -0
- package/skills/analysis/dataviz/chart-image-generator/SKILL.md +229 -0
- package/skills/analysis/dataviz/citation-map-guide/SKILL.md +184 -0
- package/skills/analysis/dataviz/d3-visualization-guide/SKILL.md +281 -0
- package/skills/analysis/dataviz/data-visualization-principles/SKILL.md +171 -0
- package/skills/analysis/dataviz/echarts-visualization-guide/SKILL.md +250 -0
- package/skills/analysis/dataviz/metabase-analytics-guide/SKILL.md +242 -0
- package/skills/analysis/dataviz/plotly-interactive-guide/SKILL.md +266 -0
- package/skills/analysis/dataviz/redash-analytics-guide/SKILL.md +284 -0
- package/skills/analysis/econometrics/econml-causal-guide/SKILL.md +163 -0
- package/skills/analysis/econometrics/empirical-paper-analysis/SKILL.md +192 -0
- package/skills/analysis/econometrics/mostly-harmless-guide/SKILL.md +139 -0
- package/skills/analysis/econometrics/panel-data-analyst/SKILL.md +259 -0
- package/skills/analysis/econometrics/panel-data-regression-workflow/SKILL.md +267 -0
- package/skills/analysis/econometrics/python-causality-guide/SKILL.md +134 -0
- package/skills/analysis/econometrics/stata-accounting-guide/SKILL.md +269 -0
- package/skills/analysis/econometrics/stata-analyst-guide/SKILL.md +245 -0
- package/skills/analysis/econometrics/stata-reference-guide/SKILL.md +293 -0
- package/skills/analysis/statistics/data-anomaly-detection/SKILL.md +157 -0
- package/skills/analysis/statistics/general-statistics-guide/SKILL.md +226 -0
- package/skills/analysis/statistics/infiagent-benchmark-guide/SKILL.md +106 -0
- package/skills/analysis/statistics/ml-experiment-tracker/SKILL.md +212 -0
- package/skills/analysis/statistics/pywayne-statistics-guide/SKILL.md +192 -0
- package/skills/analysis/statistics/quantitative-methods-guide/SKILL.md +193 -0
- package/skills/analysis/statistics/senior-data-scientist-guide/SKILL.md +223 -0
- package/skills/analysis/wrangling/claude-data-analysis-guide/SKILL.md +100 -0
- package/skills/analysis/wrangling/csv-data-analyzer/SKILL.md +170 -0
- package/skills/analysis/wrangling/data-cleaning-pipeline/SKILL.md +266 -0
- package/skills/analysis/wrangling/data-cog-guide/SKILL.md +178 -0
- package/skills/analysis/wrangling/open-data-scientist-guide/SKILL.md +197 -0
- package/skills/analysis/wrangling/stata-data-cleaning/SKILL.md +276 -0
- package/skills/analysis/wrangling/streamline-analyst-guide/SKILL.md +119 -0
- package/skills/analysis/wrangling/survey-data-processing/SKILL.md +298 -0
- package/skills/domains/ai-ml/ai-agent-papers-guide/SKILL.md +146 -0
- package/skills/domains/ai-ml/ai-model-benchmarking/SKILL.md +209 -0
- package/skills/domains/ai-ml/annotated-dl-papers-guide/SKILL.md +159 -0
- package/skills/domains/ai-ml/anomaly-detection-papers-guide/SKILL.md +167 -0
- package/skills/domains/ai-ml/autonomous-agents-papers-guide/SKILL.md +178 -0
- package/skills/domains/ai-ml/dl-transformer-finetune/SKILL.md +239 -0
- package/skills/domains/ai-ml/domain-adaptation-papers-guide/SKILL.md +173 -0
- package/skills/domains/ai-ml/generative-ai-guide/SKILL.md +146 -0
- package/skills/domains/ai-ml/graph-learning-papers-guide/SKILL.md +125 -0
- package/skills/domains/ai-ml/huggingface-inference-guide/SKILL.md +196 -0
- package/skills/domains/ai-ml/keras-deep-learning/SKILL.md +210 -0
- package/skills/domains/ai-ml/kolmogorov-arnold-networks-guide/SKILL.md +185 -0
- package/skills/domains/ai-ml/llm-from-scratch-guide/SKILL.md +124 -0
- package/skills/domains/ai-ml/ml-pipeline-guide/SKILL.md +295 -0
- package/skills/domains/ai-ml/nlp-toolkit-guide/SKILL.md +247 -0
- package/skills/domains/ai-ml/npcpy-research-guide/SKILL.md +137 -0
- package/skills/domains/ai-ml/pytorch-guide/SKILL.md +281 -0
- package/skills/domains/ai-ml/pytorch-lightning-guide/SKILL.md +244 -0
- package/skills/domains/ai-ml/responsible-ai-guide/SKILL.md +126 -0
- package/skills/domains/ai-ml/tensorflow-guide/SKILL.md +241 -0
- package/skills/domains/ai-ml/vmas-simulator-guide/SKILL.md +129 -0
- package/skills/domains/biomedical/bioagents-guide/SKILL.md +308 -0
- package/skills/domains/biomedical/clawbio-guide/SKILL.md +167 -0
- package/skills/domains/biomedical/clinical-dialogue-agents-guide/SKILL.md +145 -0
- package/skills/domains/biomedical/ena-sequence-api/SKILL.md +175 -0
- package/skills/domains/biomedical/genomas-guide/SKILL.md +126 -0
- package/skills/domains/biomedical/genotex-benchmark-guide/SKILL.md +125 -0
- package/skills/domains/biomedical/med-researcher-guide/SKILL.md +161 -0
- package/skills/domains/biomedical/med-researcher-r1-guide/SKILL.md +146 -0
- package/skills/domains/biomedical/medgeclaw-guide/SKILL.md +345 -0
- package/skills/domains/biomedical/medical-imaging-guide/SKILL.md +305 -0
- package/skills/domains/biomedical/ncbi-blast-api/SKILL.md +195 -0
- package/skills/domains/biomedical/ncbi-datasets-api/SKILL.md +220 -0
- package/skills/domains/biomedical/quickgo-api/SKILL.md +181 -0
- package/skills/domains/business/architecture-design-guide/SKILL.md +279 -0
- package/skills/domains/business/innovation-management-guide/SKILL.md +257 -0
- package/skills/domains/business/operations-research-guide/SKILL.md +258 -0
- package/skills/domains/business/xpert-bi-guide/SKILL.md +84 -0
- package/skills/domains/chemistry/cactus-cheminformatics-guide/SKILL.md +89 -0
- package/skills/domains/chemistry/chemeagle-guide/SKILL.md +147 -0
- package/skills/domains/chemistry/chemgraph-agent-guide/SKILL.md +120 -0
- package/skills/domains/chemistry/molecular-dynamics-guide/SKILL.md +237 -0
- package/skills/domains/chemistry/pubchem-api-guide/SKILL.md +180 -0
- package/skills/domains/chemistry/spectroscopy-analysis-guide/SKILL.md +290 -0
- package/skills/domains/cs/ai-security-papers-guide/SKILL.md +103 -0
- package/skills/domains/cs/code-llm-papers-guide/SKILL.md +131 -0
- package/skills/domains/cs/distributed-systems-guide/SKILL.md +268 -0
- package/skills/domains/cs/formal-verification-guide/SKILL.md +298 -0
- package/skills/domains/cs/gaussian-splatting-papers-guide/SKILL.md +158 -0
- package/skills/domains/cs/llm-aiops-guide/SKILL.md +70 -0
- package/skills/domains/cs/software-heritage-api/SKILL.md +200 -0
- package/skills/domains/ecology/species-distribution-guide/SKILL.md +343 -0
- package/skills/domains/economics/imf-data-api-guide/SKILL.md +174 -0
- package/skills/domains/economics/nber-working-papers-api/SKILL.md +177 -0
- package/skills/domains/economics/post-labor-economics/SKILL.md +254 -0
- package/skills/domains/economics/pricing-psychology-guide/SKILL.md +273 -0
- package/skills/domains/economics/repec-economics-api/SKILL.md +188 -0
- package/skills/domains/economics/world-bank-data-guide/SKILL.md +179 -0
- package/skills/domains/education/academic-study-methods/SKILL.md +228 -0
- package/skills/domains/education/assessment-design-guide/SKILL.md +213 -0
- package/skills/domains/education/educational-research-methods/SKILL.md +179 -0
- package/skills/domains/education/edumcp-guide/SKILL.md +74 -0
- package/skills/domains/education/mooc-analytics-guide/SKILL.md +206 -0
- package/skills/domains/education/open-syllabus-api/SKILL.md +171 -0
- package/skills/domains/finance/akshare-finance-data/SKILL.md +207 -0
- package/skills/domains/finance/finsight-research-guide/SKILL.md +113 -0
- package/skills/domains/finance/options-analytics-agent-guide/SKILL.md +117 -0
- package/skills/domains/finance/portfolio-optimization-guide/SKILL.md +279 -0
- package/skills/domains/finance/risk-modeling-guide/SKILL.md +260 -0
- package/skills/domains/finance/stata-accounting-research/SKILL.md +372 -0
- package/skills/domains/geoscience/climate-modeling-guide/SKILL.md +215 -0
- package/skills/domains/geoscience/pangaea-data-api/SKILL.md +197 -0
- package/skills/domains/geoscience/satellite-remote-sensing/SKILL.md +193 -0
- package/skills/domains/geoscience/seismology-data-guide/SKILL.md +208 -0
- package/skills/domains/humanities/digital-humanities-methods/SKILL.md +232 -0
- package/skills/domains/humanities/ethical-philosophy-guide/SKILL.md +244 -0
- package/skills/domains/humanities/history-research-guide/SKILL.md +260 -0
- package/skills/domains/humanities/political-history-guide/SKILL.md +241 -0
- package/skills/domains/law/caselaw-access-api/SKILL.md +149 -0
- package/skills/domains/law/legal-agent-skills-guide/SKILL.md +132 -0
- package/skills/domains/law/legal-nlp-guide/SKILL.md +236 -0
- package/skills/domains/law/legal-research-methods/SKILL.md +190 -0
- package/skills/domains/law/opencontracts-guide/SKILL.md +168 -0
- package/skills/domains/law/patent-analysis-guide/SKILL.md +257 -0
- package/skills/domains/law/regulatory-compliance-guide/SKILL.md +267 -0
- package/skills/domains/math/lean-theorem-proving-guide/SKILL.md +140 -0
- package/skills/domains/math/symbolic-computation-guide/SKILL.md +263 -0
- package/skills/domains/math/topology-data-analysis/SKILL.md +305 -0
- package/skills/domains/pharma/clinical-trial-design-guide/SKILL.md +271 -0
- package/skills/domains/pharma/drug-target-interaction/SKILL.md +242 -0
- package/skills/domains/pharma/madd-drug-discovery-guide/SKILL.md +153 -0
- package/skills/domains/pharma/pharmacovigilance-guide/SKILL.md +216 -0
- package/skills/domains/physics/astrophysics-data-guide/SKILL.md +305 -0
- package/skills/domains/physics/particle-physics-guide/SKILL.md +287 -0
- package/skills/domains/social-science/ipums-microdata-api/SKILL.md +211 -0
- package/skills/domains/social-science/network-analysis-guide/SKILL.md +310 -0
- package/skills/domains/social-science/psychology-research-guide/SKILL.md +270 -0
- package/skills/domains/social-science/sociology-research-guide/SKILL.md +238 -0
- package/skills/domains/social-science/sociology-research-methods/SKILL.md +181 -0
- package/skills/literature/discovery/arxiv-paper-monitoring/SKILL.md +233 -0
- package/skills/literature/discovery/paper-recommendation-guide/SKILL.md +120 -0
- package/skills/literature/discovery/papers-we-love-guide/SKILL.md +169 -0
- package/skills/literature/discovery/semantic-paper-radar/SKILL.md +144 -0
- package/skills/literature/discovery/zotero-arxiv-daily-guide/SKILL.md +94 -0
- package/skills/literature/fulltext/bioc-pmc-api/SKILL.md +146 -0
- package/skills/literature/fulltext/core-api-guide/SKILL.md +144 -0
- package/skills/literature/fulltext/dataverse-api/SKILL.md +215 -0
- package/skills/literature/fulltext/hal-archive-api/SKILL.md +218 -0
- package/skills/literature/fulltext/institutional-repository-guide/SKILL.md +212 -0
- package/skills/literature/fulltext/open-access-mining-guide/SKILL.md +341 -0
- package/skills/literature/fulltext/osf-api/SKILL.md +212 -0
- package/skills/literature/fulltext/pmc-ftp-bulk-download/SKILL.md +182 -0
- package/skills/literature/fulltext/zotero-ai-butler-guide/SKILL.md +166 -0
- package/skills/literature/fulltext/zotero-scihub-guide/SKILL.md +168 -0
- package/skills/literature/metadata/academic-paper-summarizer/SKILL.md +101 -0
- package/skills/literature/metadata/bibliometrix-guide/SKILL.md +164 -0
- package/skills/literature/metadata/crossref-event-data-api/SKILL.md +183 -0
- package/skills/literature/metadata/doi-content-negotiation/SKILL.md +202 -0
- package/skills/literature/metadata/orkg-api/SKILL.md +153 -0
- package/skills/literature/metadata/plumx-metrics-api/SKILL.md +188 -0
- package/skills/literature/metadata/ror-organization-api/SKILL.md +208 -0
- package/skills/literature/metadata/sophosia-reference-guide/SKILL.md +110 -0
- package/skills/literature/metadata/viaf-authority-api/SKILL.md +209 -0
- package/skills/literature/metadata/wikidata-api-guide/SKILL.md +156 -0
- package/skills/literature/metadata/zoplicate-dedup-guide/SKILL.md +147 -0
- package/skills/literature/metadata/zotero-actions-tags-guide/SKILL.md +212 -0
- package/skills/literature/metadata/zotmoov-guide/SKILL.md +120 -0
- package/skills/literature/metadata/zutilo-guide/SKILL.md +140 -0
- package/skills/literature/search/arxiv-batch-reporting/SKILL.md +133 -0
- package/skills/literature/search/arxiv-cli-tools/SKILL.md +172 -0
- package/skills/literature/search/arxiv-osiris/SKILL.md +199 -0
- package/skills/literature/search/arxiv-paper-processor/SKILL.md +141 -0
- package/skills/literature/search/baidu-scholar-guide/SKILL.md +110 -0
- package/skills/literature/search/base-academic-search/SKILL.md +196 -0
- package/skills/literature/search/chatpaper-guide/SKILL.md +122 -0
- package/skills/literature/search/citeseerx-api/SKILL.md +183 -0
- package/skills/literature/search/deep-literature-search/SKILL.md +149 -0
- package/skills/literature/search/deepgit-search-guide/SKILL.md +147 -0
- package/skills/literature/search/eric-education-api/SKILL.md +199 -0
- package/skills/literature/search/findpapers-guide/SKILL.md +177 -0
- package/skills/literature/search/ieee-xplore-api/SKILL.md +177 -0
- package/skills/literature/search/lens-scholarly-api/SKILL.md +211 -0
- package/skills/literature/search/multi-database-literature-search/SKILL.md +198 -0
- package/skills/literature/search/open-library-api/SKILL.md +196 -0
- package/skills/literature/search/open-semantic-search-guide/SKILL.md +190 -0
- package/skills/literature/search/openaire-api/SKILL.md +141 -0
- package/skills/literature/search/paper-search-mcp-guide/SKILL.md +107 -0
- package/skills/literature/search/papers-chat-guide/SKILL.md +194 -0
- package/skills/literature/search/pasa-paper-search-guide/SKILL.md +138 -0
- package/skills/literature/search/plos-open-access-api/SKILL.md +203 -0
- package/skills/literature/search/scielo-api/SKILL.md +182 -0
- package/skills/literature/search/share-research-api/SKILL.md +129 -0
- package/skills/literature/search/worldcat-search-api/SKILL.md +224 -0
- package/skills/research/automation/ai-scientist-v2-guide/SKILL.md +284 -0
- package/skills/research/automation/aim-experiment-guide/SKILL.md +234 -0
- package/skills/research/automation/claude-academic-workflow-guide/SKILL.md +202 -0
- package/skills/research/automation/coexist-ai-guide/SKILL.md +149 -0
- package/skills/research/automation/datagen-research-guide/SKILL.md +131 -0
- package/skills/research/automation/foam-agent-guide/SKILL.md +203 -0
- package/skills/research/automation/kedro-pipeline-guide/SKILL.md +216 -0
- package/skills/research/automation/mle-agent-guide/SKILL.md +139 -0
- package/skills/research/automation/paper-to-agent-guide/SKILL.md +116 -0
- package/skills/research/automation/rd-agent-guide/SKILL.md +246 -0
- package/skills/research/automation/research-paper-orchestrator/SKILL.md +254 -0
- package/skills/research/deep-research/academic-deep-research/SKILL.md +190 -0
- package/skills/research/deep-research/auto-deep-research-guide/SKILL.md +141 -0
- package/skills/research/deep-research/cognitive-kernel-guide/SKILL.md +200 -0
- package/skills/research/deep-research/corvus-research-guide/SKILL.md +132 -0
- package/skills/research/deep-research/deep-research-pro/SKILL.md +213 -0
- package/skills/research/deep-research/deep-research-work/SKILL.md +204 -0
- package/skills/research/deep-research/deep-searcher-guide/SKILL.md +253 -0
- package/skills/research/deep-research/gpt-researcher-guide/SKILL.md +191 -0
- package/skills/research/deep-research/in-depth-research-guide/SKILL.md +205 -0
- package/skills/research/deep-research/khoj-research-guide/SKILL.md +200 -0
- package/skills/research/deep-research/kosmos-scientist-guide/SKILL.md +185 -0
- package/skills/research/deep-research/llm-scientific-discovery-guide/SKILL.md +178 -0
- package/skills/research/deep-research/local-deep-research-guide/SKILL.md +253 -0
- package/skills/research/deep-research/open-researcher-guide/SKILL.md +138 -0
- package/skills/research/deep-research/tongyi-deep-research-guide/SKILL.md +217 -0
- package/skills/research/funding/eu-horizon-guide/SKILL.md +244 -0
- package/skills/research/funding/grant-budget-guide/SKILL.md +284 -0
- package/skills/research/funding/nih-reporter-api-guide/SKILL.md +166 -0
- package/skills/research/funding/nsf-award-api-guide/SKILL.md +133 -0
- package/skills/research/methodology/academic-mentor-guide/SKILL.md +169 -0
- package/skills/research/methodology/claude-scientific-guide/SKILL.md +122 -0
- package/skills/research/methodology/deep-innovator-guide/SKILL.md +242 -0
- package/skills/research/methodology/osf-api-guide/SKILL.md +165 -0
- package/skills/research/methodology/parsifal-slr-guide/SKILL.md +154 -0
- package/skills/research/methodology/research-paper-kb/SKILL.md +263 -0
- package/skills/research/methodology/research-pipeline-units-guide/SKILL.md +169 -0
- package/skills/research/methodology/research-town-guide/SKILL.md +263 -0
- package/skills/research/methodology/slr-automation-guide/SKILL.md +235 -0
- package/skills/research/paper-review/automated-review-guide/SKILL.md +281 -0
- package/skills/research/paper-review/latte-review-guide/SKILL.md +175 -0
- package/skills/research/paper-review/paper-compare-guide/SKILL.md +238 -0
- package/skills/research/paper-review/paper-critique-framework/SKILL.md +181 -0
- package/skills/research/paper-review/paper-digest-guide/SKILL.md +240 -0
- package/skills/research/paper-review/paper-research-assistant/SKILL.md +231 -0
- package/skills/research/paper-review/research-quality-filter/SKILL.md +261 -0
- package/skills/research/paper-review/review-response-guide/SKILL.md +275 -0
- package/skills/tools/code-exec/contextplus-mcp-guide/SKILL.md +110 -0
- package/skills/tools/code-exec/google-colab-guide/SKILL.md +276 -0
- package/skills/tools/code-exec/kaggle-api-guide/SKILL.md +216 -0
- package/skills/tools/code-exec/overleaf-cli-guide/SKILL.md +279 -0
- package/skills/tools/diagram/clawphd-guide/SKILL.md +149 -0
- package/skills/tools/diagram/code-flow-visualizer/SKILL.md +197 -0
- package/skills/tools/diagram/excalidraw-diagram-guide/SKILL.md +170 -0
- package/skills/tools/diagram/json-data-visualizer/SKILL.md +270 -0
- package/skills/tools/diagram/kroki-diagram-api/SKILL.md +198 -0
- package/skills/tools/diagram/mermaid-architect-guide/SKILL.md +219 -0
- package/skills/tools/diagram/scientific-graphical-abstract/SKILL.md +201 -0
- package/skills/tools/diagram/tldraw-whiteboard-guide/SKILL.md +397 -0
- package/skills/tools/document/docsgpt-guide/SKILL.md +130 -0
- package/skills/tools/document/large-document-reader/SKILL.md +202 -0
- package/skills/tools/document/md2pdf-xelatex/SKILL.md +212 -0
- package/skills/tools/document/openpaper-guide/SKILL.md +232 -0
- package/skills/tools/document/paper-parse-guide/SKILL.md +243 -0
- package/skills/tools/document/weknora-guide/SKILL.md +216 -0
- package/skills/tools/document/zotero-addon-market-guide/SKILL.md +108 -0
- package/skills/tools/document/zotero-night-theme-guide/SKILL.md +142 -0
- package/skills/tools/document/zotero-style-guide/SKILL.md +217 -0
- package/skills/tools/knowledge-graph/citation-network-builder/SKILL.md +244 -0
- package/skills/tools/knowledge-graph/concept-map-generator/SKILL.md +284 -0
- package/skills/tools/knowledge-graph/graphiti-guide/SKILL.md +219 -0
- package/skills/tools/knowledge-graph/mimir-memory-guide/SKILL.md +135 -0
- package/skills/tools/knowledge-graph/notero-zotero-notion-guide/SKILL.md +187 -0
- package/skills/tools/knowledge-graph/open-webui-tools-guide/SKILL.md +156 -0
- package/skills/tools/knowledge-graph/openspg-guide/SKILL.md +210 -0
- package/skills/tools/knowledge-graph/paperpile-notion-guide/SKILL.md +84 -0
- package/skills/tools/knowledge-graph/zotero-markdb-connect-guide/SKILL.md +162 -0
- package/skills/tools/ocr-translate/latex-translation-guide/SKILL.md +176 -0
- package/skills/tools/ocr-translate/math-equation-renderer/SKILL.md +198 -0
- package/skills/tools/ocr-translate/pdf-math-translate-guide/SKILL.md +141 -0
- package/skills/tools/ocr-translate/zotero-pdf-translate-guide/SKILL.md +95 -0
- package/skills/tools/ocr-translate/zotero-pdf2zh-guide/SKILL.md +143 -0
- package/skills/tools/scraping/dataset-finder-guide/SKILL.md +253 -0
- package/skills/tools/scraping/easy-spider-guide/SKILL.md +250 -0
- package/skills/tools/scraping/google-scholar-scraper/SKILL.md +255 -0
- package/skills/tools/scraping/repository-harvesting-guide/SKILL.md +310 -0
- package/skills/writing/citation/academic-citation-manager/SKILL.md +314 -0
- package/skills/writing/citation/academic-citation-manager-guide/SKILL.md +182 -0
- package/skills/writing/citation/citation-assistant-skill/SKILL.md +192 -0
- package/skills/writing/citation/jabref-reference-guide/SKILL.md +127 -0
- package/skills/writing/citation/jasminum-zotero-guide/SKILL.md +103 -0
- package/skills/writing/citation/mendeley-api/SKILL.md +231 -0
- package/skills/writing/citation/obsidian-citation-guide/SKILL.md +164 -0
- package/skills/writing/citation/obsidian-zotero-guide/SKILL.md +137 -0
- package/skills/writing/citation/onecite-reference-guide/SKILL.md +168 -0
- package/skills/writing/citation/papersgpt-zotero-guide/SKILL.md +132 -0
- package/skills/writing/citation/papis-cli-guide/SKILL.md +213 -0
- package/skills/writing/citation/zotero-better-bibtex-guide/SKILL.md +107 -0
- package/skills/writing/citation/zotero-better-notes-guide/SKILL.md +121 -0
- package/skills/writing/citation/zotero-gpt-guide/SKILL.md +111 -0
- package/skills/writing/citation/zotero-mcp-guide/SKILL.md +164 -0
- package/skills/writing/citation/zotero-mdnotes-guide/SKILL.md +162 -0
- package/skills/writing/citation/zotero-reference-guide/SKILL.md +139 -0
- package/skills/writing/citation/zotero-scholar-guide/SKILL.md +294 -0
- package/skills/writing/citation/zotfile-attachment-guide/SKILL.md +140 -0
- package/skills/writing/composition/ml-paper-writing/SKILL.md +163 -0
- package/skills/writing/composition/opendraft-thesis-guide/SKILL.md +200 -0
- package/skills/writing/composition/paper-debugger-guide/SKILL.md +143 -0
- package/skills/writing/composition/paperforge-guide/SKILL.md +205 -0
- package/skills/writing/composition/research-paper-writer/SKILL.md +226 -0
- package/skills/writing/composition/scientific-writing-resources/SKILL.md +151 -0
- package/skills/writing/composition/scientific-writing-wrapper/SKILL.md +153 -0
- package/skills/writing/latex/academic-writing-latex/SKILL.md +285 -0
- package/skills/writing/latex/latex-drawing-collection/SKILL.md +154 -0
- package/skills/writing/latex/latex-templates-collection/SKILL.md +159 -0
- package/skills/writing/latex/md-to-pdf-academic/SKILL.md +230 -0
- package/skills/writing/latex/tex-render-guide/SKILL.md +243 -0
- package/skills/writing/polish/academic-tone-guide/SKILL.md +209 -0
- package/skills/writing/polish/chinese-text-humanizer/SKILL.md +140 -0
- package/skills/writing/polish/conciseness-editing-guide/SKILL.md +225 -0
- package/skills/writing/polish/paper-polish-guide/SKILL.md +160 -0
- package/skills/writing/templates/arxiv-preprint-template/SKILL.md +184 -0
- package/skills/writing/templates/elegant-paper-template/SKILL.md +141 -0
- package/skills/writing/templates/graphical-abstract-guide/SKILL.md +183 -0
- package/skills/writing/templates/novathesis-guide/SKILL.md +152 -0
- package/skills/writing/templates/scientific-article-pdf/SKILL.md +261 -0
- package/skills/writing/templates/sjtuthesis-guide/SKILL.md +197 -0
- package/skills/writing/templates/thuthesis-guide/SKILL.md +181 -0
- package/skills/literature/fulltext/repository-harvesting-guide/SKILL.md +0 -207
|
@@ -0,0 +1,276 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: google-colab-guide
|
|
3
|
+
description: "Run and manage Google Colab notebooks for Python and ML research"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "gpu"
|
|
7
|
+
category: "tools"
|
|
8
|
+
subcategory: "code-exec"
|
|
9
|
+
keywords: ["Google Colab", "Jupyter", "GPU", "machine learning", "Python", "cloud computing"]
|
|
10
|
+
source: "https://colab.research.google.com"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Google Colab Guide
|
|
14
|
+
|
|
15
|
+
Run Python code, train machine learning models, and perform data analysis using Google Colab's free cloud-hosted Jupyter notebooks with GPU and TPU access. This skill covers setup, resource management, persistent storage, and best practices for reproducible research computing.
|
|
16
|
+
|
|
17
|
+
## Overview
|
|
18
|
+
|
|
19
|
+
Google Colab (Colaboratory) provides free access to GPU-accelerated Jupyter notebooks running on Google's cloud infrastructure. For academic researchers, Colab eliminates the barrier of expensive hardware for machine learning experiments, large-scale data processing, and computationally intensive statistical analyses. The free tier includes NVIDIA T4 GPUs, and paid tiers (Colab Pro, Pro+) offer A100 GPUs and extended runtime.
|
|
20
|
+
|
|
21
|
+
Colab notebooks run in ephemeral virtual machines that are recycled after inactivity or maximum runtime. This creates unique challenges for research: managing persistent data, saving checkpoints, reproducing results, and working with large datasets. This skill addresses these challenges with proven patterns used by ML researchers worldwide.
|
|
22
|
+
|
|
23
|
+
Colab integrates natively with Google Drive for storage, GitHub for version control, and supports the full Python scientific computing ecosystem (NumPy, pandas, scikit-learn, PyTorch, TensorFlow, JAX). Each notebook runs in an isolated environment with root access, allowing installation of any Linux package or Python library.
|
|
24
|
+
|
|
25
|
+
## Getting Started
|
|
26
|
+
|
|
27
|
+
### Runtime Configuration
|
|
28
|
+
|
|
29
|
+
```python
|
|
30
|
+
# Check current runtime type
|
|
31
|
+
import subprocess
|
|
32
|
+
result = subprocess.run(['nvidia-smi'], capture_output=True, text=True)
|
|
33
|
+
print(result.stdout) # Shows GPU info if GPU runtime is selected
|
|
34
|
+
|
|
35
|
+
# Check available resources
|
|
36
|
+
import psutil
|
|
37
|
+
print(f"RAM: {psutil.virtual_memory().total / 1e9:.1f} GB")
|
|
38
|
+
print(f"CPU cores: {psutil.cpu_count()}")
|
|
39
|
+
print(f"Disk: {psutil.disk_usage('/').total / 1e9:.1f} GB")
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Runtime Selection Guide
|
|
43
|
+
|
|
44
|
+
| Runtime | GPU | RAM | Use Case |
|
|
45
|
+
|---------|-----|-----|----------|
|
|
46
|
+
| CPU | None | ~12 GB | Data cleaning, text processing, small models |
|
|
47
|
+
| T4 GPU (free) | 16 GB VRAM | ~12 GB | Training medium models, inference |
|
|
48
|
+
| A100 GPU (Pro) | 40 GB VRAM | ~50 GB | Large model training, LLM fine-tuning |
|
|
49
|
+
| TPU v2 (free) | 8 cores | ~12 GB | JAX/TensorFlow distributed training |
|
|
50
|
+
|
|
51
|
+
### Google Drive Mount
|
|
52
|
+
|
|
53
|
+
```python
|
|
54
|
+
from google.colab import drive
|
|
55
|
+
drive.mount('/content/drive')
|
|
56
|
+
|
|
57
|
+
# Access files in Drive
|
|
58
|
+
import pandas as pd
|
|
59
|
+
df = pd.read_csv('/content/drive/MyDrive/research/dataset.csv')
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Data Management
|
|
63
|
+
|
|
64
|
+
### Downloading Datasets
|
|
65
|
+
|
|
66
|
+
```python
|
|
67
|
+
# From URL
|
|
68
|
+
!wget -q https://example.com/dataset.zip -O /content/dataset.zip
|
|
69
|
+
!unzip -q /content/dataset.zip -d /content/data/
|
|
70
|
+
|
|
71
|
+
# From Kaggle
|
|
72
|
+
!pip install -q kaggle
|
|
73
|
+
!mkdir -p ~/.kaggle
|
|
74
|
+
# Upload kaggle.json API key first
|
|
75
|
+
!kaggle datasets download -d user/dataset-name -p /content/data/
|
|
76
|
+
|
|
77
|
+
# From Hugging Face
|
|
78
|
+
!pip install -q datasets
|
|
79
|
+
from datasets import load_dataset
|
|
80
|
+
dataset = load_dataset("scientific_papers", "arxiv")
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Persistent Storage Patterns
|
|
84
|
+
|
|
85
|
+
Since Colab VMs are ephemeral, always save important outputs to Google Drive:
|
|
86
|
+
|
|
87
|
+
```python
|
|
88
|
+
import shutil
|
|
89
|
+
from pathlib import Path
|
|
90
|
+
|
|
91
|
+
DRIVE_BASE = Path("/content/drive/MyDrive/research/experiment_001")
|
|
92
|
+
DRIVE_BASE.mkdir(parents=True, exist_ok=True)
|
|
93
|
+
|
|
94
|
+
def save_checkpoint(model, optimizer, epoch, loss):
|
|
95
|
+
"""Save training checkpoint to Google Drive."""
|
|
96
|
+
checkpoint = {
|
|
97
|
+
'epoch': epoch,
|
|
98
|
+
'model_state_dict': model.state_dict(),
|
|
99
|
+
'optimizer_state_dict': optimizer.state_dict(),
|
|
100
|
+
'loss': loss
|
|
101
|
+
}
|
|
102
|
+
path = DRIVE_BASE / f"checkpoint_epoch_{epoch}.pt"
|
|
103
|
+
torch.save(checkpoint, path)
|
|
104
|
+
print(f"Checkpoint saved to {path}")
|
|
105
|
+
|
|
106
|
+
def save_results(df, name):
|
|
107
|
+
"""Save results DataFrame to Drive."""
|
|
108
|
+
path = DRIVE_BASE / f"{name}.csv"
|
|
109
|
+
df.to_csv(path, index=False)
|
|
110
|
+
print(f"Results saved to {path}")
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Machine Learning Workflows
|
|
114
|
+
|
|
115
|
+
### PyTorch Training Loop
|
|
116
|
+
|
|
117
|
+
```python
|
|
118
|
+
!pip install -q torch torchvision
|
|
119
|
+
|
|
120
|
+
import torch
|
|
121
|
+
import torch.nn as nn
|
|
122
|
+
from torch.utils.data import DataLoader
|
|
123
|
+
|
|
124
|
+
# Automatic device selection
|
|
125
|
+
device = torch.device('cuda' if torch.cuda.is_available() else 'cpu')
|
|
126
|
+
print(f"Using device: {device}")
|
|
127
|
+
|
|
128
|
+
model = MyModel().to(device)
|
|
129
|
+
optimizer = torch.optim.AdamW(model.parameters(), lr=1e-4)
|
|
130
|
+
criterion = nn.CrossEntropyLoss()
|
|
131
|
+
|
|
132
|
+
for epoch in range(num_epochs):
|
|
133
|
+
model.train()
|
|
134
|
+
total_loss = 0
|
|
135
|
+
for batch in train_loader:
|
|
136
|
+
inputs, labels = batch[0].to(device), batch[1].to(device)
|
|
137
|
+
optimizer.zero_grad()
|
|
138
|
+
outputs = model(inputs)
|
|
139
|
+
loss = criterion(outputs, labels)
|
|
140
|
+
loss.backward()
|
|
141
|
+
optimizer.step()
|
|
142
|
+
total_loss += loss.item()
|
|
143
|
+
|
|
144
|
+
avg_loss = total_loss / len(train_loader)
|
|
145
|
+
print(f"Epoch {epoch+1}/{num_epochs}, Loss: {avg_loss:.4f}")
|
|
146
|
+
|
|
147
|
+
# Save checkpoint every 5 epochs
|
|
148
|
+
if (epoch + 1) % 5 == 0:
|
|
149
|
+
save_checkpoint(model, optimizer, epoch + 1, avg_loss)
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Hugging Face Transformers
|
|
153
|
+
|
|
154
|
+
```python
|
|
155
|
+
!pip install -q transformers accelerate
|
|
156
|
+
|
|
157
|
+
from transformers import AutoTokenizer, AutoModelForSequenceClassification, Trainer
|
|
158
|
+
|
|
159
|
+
model_name = "allenai/scibert_scivocab_uncased"
|
|
160
|
+
tokenizer = AutoTokenizer.from_pretrained(model_name)
|
|
161
|
+
model = AutoModelForSequenceClassification.from_pretrained(
|
|
162
|
+
model_name, num_labels=5
|
|
163
|
+
)
|
|
164
|
+
|
|
165
|
+
trainer = Trainer(
|
|
166
|
+
model=model,
|
|
167
|
+
args=training_args,
|
|
168
|
+
train_dataset=train_dataset,
|
|
169
|
+
eval_dataset=eval_dataset,
|
|
170
|
+
tokenizer=tokenizer
|
|
171
|
+
)
|
|
172
|
+
trainer.train()
|
|
173
|
+
|
|
174
|
+
# Save to Drive
|
|
175
|
+
model.save_pretrained(str(DRIVE_BASE / "fine_tuned_scibert"))
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
## Environment Management
|
|
179
|
+
|
|
180
|
+
### Installing Packages
|
|
181
|
+
|
|
182
|
+
```python
|
|
183
|
+
# Install specific versions for reproducibility
|
|
184
|
+
!pip install -q transformers==4.40.0 datasets==2.18.0 evaluate==0.4.1
|
|
185
|
+
|
|
186
|
+
# Install from GitHub
|
|
187
|
+
!pip install -q git+https://github.com/huggingface/peft.git
|
|
188
|
+
|
|
189
|
+
# Install system packages
|
|
190
|
+
!apt-get -qq install -y graphviz texlive-latex-base
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Reproducibility Setup
|
|
194
|
+
|
|
195
|
+
```python
|
|
196
|
+
import random
|
|
197
|
+
import numpy as np
|
|
198
|
+
import torch
|
|
199
|
+
|
|
200
|
+
def set_seed(seed=42):
|
|
201
|
+
"""Set all random seeds for reproducibility."""
|
|
202
|
+
random.seed(seed)
|
|
203
|
+
np.random.seed(seed)
|
|
204
|
+
torch.manual_seed(seed)
|
|
205
|
+
torch.cuda.manual_seed_all(seed)
|
|
206
|
+
torch.backends.cudnn.deterministic = True
|
|
207
|
+
torch.backends.cudnn.benchmark = False
|
|
208
|
+
|
|
209
|
+
set_seed(42)
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Requirements File
|
|
213
|
+
|
|
214
|
+
```python
|
|
215
|
+
# Generate requirements for reproducibility
|
|
216
|
+
!pip freeze > /content/drive/MyDrive/research/requirements.txt
|
|
217
|
+
|
|
218
|
+
# Restore environment in new session
|
|
219
|
+
!pip install -q -r /content/drive/MyDrive/research/requirements.txt
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
## Performance Optimization
|
|
223
|
+
|
|
224
|
+
### Memory Management
|
|
225
|
+
|
|
226
|
+
```python
|
|
227
|
+
# Monitor GPU memory
|
|
228
|
+
!nvidia-smi
|
|
229
|
+
|
|
230
|
+
# Clear GPU cache
|
|
231
|
+
torch.cuda.empty_cache()
|
|
232
|
+
|
|
233
|
+
# Use mixed precision training for 2x speedup
|
|
234
|
+
from torch.cuda.amp import autocast, GradScaler
|
|
235
|
+
scaler = GradScaler()
|
|
236
|
+
|
|
237
|
+
for batch in train_loader:
|
|
238
|
+
optimizer.zero_grad()
|
|
239
|
+
with autocast():
|
|
240
|
+
outputs = model(inputs)
|
|
241
|
+
loss = criterion(outputs, labels)
|
|
242
|
+
scaler.scale(loss).backward()
|
|
243
|
+
scaler.step(optimizer)
|
|
244
|
+
scaler.update()
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
### Preventing Disconnection
|
|
248
|
+
|
|
249
|
+
Colab disconnects after 90 minutes of inactivity (free tier). Strategies:
|
|
250
|
+
|
|
251
|
+
1. Use `tqdm` progress bars to show activity
|
|
252
|
+
2. Save checkpoints frequently to Google Drive
|
|
253
|
+
3. Structure experiments to complete within single sessions
|
|
254
|
+
4. Use Colab Pro for longer runtimes (24 hours)
|
|
255
|
+
|
|
256
|
+
## GitHub Integration
|
|
257
|
+
|
|
258
|
+
```python
|
|
259
|
+
# Clone a research repository
|
|
260
|
+
!git clone https://github.com/user/research-repo.git /content/repo
|
|
261
|
+
|
|
262
|
+
# Push results back
|
|
263
|
+
%cd /content/repo
|
|
264
|
+
!git config user.email "researcher@university.edu"
|
|
265
|
+
!git config user.name "Researcher"
|
|
266
|
+
!git add results/
|
|
267
|
+
!git commit -m "Add experiment results from Colab"
|
|
268
|
+
!git push
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
## References
|
|
272
|
+
|
|
273
|
+
- Google Colab documentation: https://colab.research.google.com/notebooks/intro.ipynb
|
|
274
|
+
- Colab resource limits FAQ: https://research.google.com/colaboratory/faq.html
|
|
275
|
+
- PyTorch on Colab: https://pytorch.org/tutorials/beginner/colab
|
|
276
|
+
- Hugging Face + Colab: https://huggingface.co/docs/transformers/notebooks
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: kaggle-api-guide
|
|
3
|
+
description: "Download datasets, manage competitions and notebooks via Kaggle API"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "📈"
|
|
7
|
+
category: "tools"
|
|
8
|
+
subcategory: "code-exec"
|
|
9
|
+
keywords: ["kaggle", "datasets", "competitions", "notebooks", "data-science", "machine-learning"]
|
|
10
|
+
source: "https://www.kaggle.com/docs/api"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Kaggle API Guide
|
|
14
|
+
|
|
15
|
+
## Overview
|
|
16
|
+
|
|
17
|
+
Kaggle is the world's largest data science and machine learning community, hosting thousands of datasets, competitions, and computational notebooks. The Kaggle API provides programmatic access to these resources, enabling researchers to download datasets, submit competition entries, manage kernels (notebooks), and explore the Kaggle ecosystem from the command line or scripts.
|
|
18
|
+
|
|
19
|
+
For academic researchers, Kaggle is a valuable resource for accessing curated, well-documented datasets across diverse domains including healthcare, natural language processing, computer vision, economics, and social sciences. Many published research papers use Kaggle datasets as benchmarks, and the platform's competition infrastructure provides standardized evaluation frameworks for comparing methods.
|
|
20
|
+
|
|
21
|
+
The Kaggle API is available as a Python CLI tool and library. It requires a free Kaggle account and API token for authentication. The API supports dataset search and download, competition data retrieval, kernel management, and model access.
|
|
22
|
+
|
|
23
|
+
## Authentication
|
|
24
|
+
|
|
25
|
+
A free Kaggle API token is required. Generate one from your Kaggle account settings at https://www.kaggle.com/settings.
|
|
26
|
+
|
|
27
|
+
Download the `kaggle.json` credentials file and place it in the standard location:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# The kaggle.json file should be at ~/.kaggle/kaggle.json
|
|
31
|
+
# It contains your username and key from your Kaggle account settings
|
|
32
|
+
mkdir -p ~/.kaggle
|
|
33
|
+
# Move your downloaded kaggle.json to ~/.kaggle/kaggle.json
|
|
34
|
+
chmod 600 ~/.kaggle/kaggle.json
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Alternatively, use environment variables:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
export KAGGLE_USERNAME=$KAGGLE_USERNAME
|
|
41
|
+
export KAGGLE_KEY=$KAGGLE_KEY
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Install the CLI tool:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
pip install kaggle
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Core Endpoints
|
|
51
|
+
|
|
52
|
+
### Search Datasets
|
|
53
|
+
|
|
54
|
+
Find datasets by keyword, file type, or license.
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# Search for datasets
|
|
58
|
+
kaggle datasets list -s "climate change" --sort-by votes
|
|
59
|
+
|
|
60
|
+
# Search with specific criteria
|
|
61
|
+
kaggle datasets list -s "medical imaging" --file-type csv --max-size 1000000
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Download a Dataset
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# Download and unzip a dataset
|
|
68
|
+
kaggle datasets download -d "heptapod/titanic" --unzip -p ./data/titanic/
|
|
69
|
+
|
|
70
|
+
# Download a specific file from a dataset
|
|
71
|
+
kaggle datasets download -d "yelp-dataset/yelp-dataset" -f "yelp_academic_dataset_review.json" -p ./data/
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### List and Join Competitions
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# List active competitions
|
|
78
|
+
kaggle competitions list
|
|
79
|
+
|
|
80
|
+
# Download competition data (must accept rules on kaggle.com first)
|
|
81
|
+
kaggle competitions download -c "house-prices-advanced-regression-techniques" -p ./data/house-prices/
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Submit to a Competition
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# Submit predictions
|
|
88
|
+
kaggle competitions submit -c "house-prices-advanced-regression-techniques" \
|
|
89
|
+
-f ./submission.csv -m "Random forest baseline v1"
|
|
90
|
+
|
|
91
|
+
# Check submission status
|
|
92
|
+
kaggle competitions submissions -c "house-prices-advanced-regression-techniques"
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Manage Notebooks (Kernels)
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
# Search for notebooks
|
|
99
|
+
kaggle kernels list -s "transformer nlp" --sort-by voteCount
|
|
100
|
+
|
|
101
|
+
# Pull a notebook to local
|
|
102
|
+
kaggle kernels pull "username/notebook-name" -p ./notebooks/
|
|
103
|
+
|
|
104
|
+
# Push a notebook to Kaggle
|
|
105
|
+
kaggle kernels push -p ./my-notebook/
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Python Example: Automated Dataset Discovery and Download
|
|
109
|
+
|
|
110
|
+
```python
|
|
111
|
+
import subprocess
|
|
112
|
+
import json
|
|
113
|
+
import os
|
|
114
|
+
|
|
115
|
+
def search_kaggle_datasets(query, sort_by="votes", max_results=10):
|
|
116
|
+
"""Search Kaggle datasets and return structured results."""
|
|
117
|
+
cmd = [
|
|
118
|
+
"kaggle", "datasets", "list",
|
|
119
|
+
"-s", query,
|
|
120
|
+
"--sort-by", sort_by,
|
|
121
|
+
"--max-size", "50000000",
|
|
122
|
+
"--csv"
|
|
123
|
+
]
|
|
124
|
+
result = subprocess.run(cmd, capture_output=True, text=True)
|
|
125
|
+
lines = result.stdout.strip().split("\n")
|
|
126
|
+
if len(lines) < 2:
|
|
127
|
+
return []
|
|
128
|
+
|
|
129
|
+
headers = lines[0].split(",")
|
|
130
|
+
datasets = []
|
|
131
|
+
for line in lines[1:max_results + 1]:
|
|
132
|
+
values = line.split(",")
|
|
133
|
+
dataset = dict(zip(headers, values))
|
|
134
|
+
datasets.append(dataset)
|
|
135
|
+
return datasets
|
|
136
|
+
|
|
137
|
+
def download_dataset(dataset_ref, output_dir="./data"):
|
|
138
|
+
"""Download a Kaggle dataset by reference."""
|
|
139
|
+
os.makedirs(output_dir, exist_ok=True)
|
|
140
|
+
cmd = [
|
|
141
|
+
"kaggle", "datasets", "download",
|
|
142
|
+
"-d", dataset_ref,
|
|
143
|
+
"--unzip",
|
|
144
|
+
"-p", output_dir
|
|
145
|
+
]
|
|
146
|
+
result = subprocess.run(cmd, capture_output=True, text=True)
|
|
147
|
+
if result.returncode == 0:
|
|
148
|
+
print(f"Downloaded {dataset_ref} to {output_dir}")
|
|
149
|
+
else:
|
|
150
|
+
print(f"Error: {result.stderr}")
|
|
151
|
+
|
|
152
|
+
# Search for NLP benchmark datasets
|
|
153
|
+
datasets = search_kaggle_datasets("nlp text classification benchmark")
|
|
154
|
+
for ds in datasets[:5]:
|
|
155
|
+
print(f" {ds.get('ref', 'N/A')}")
|
|
156
|
+
print(f" Size: {ds.get('totalBytes', 'N/A')} bytes")
|
|
157
|
+
print(f" Votes: {ds.get('voteCount', 'N/A')}")
|
|
158
|
+
print()
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Python Example: Using the Kaggle Python API Directly
|
|
162
|
+
|
|
163
|
+
```python
|
|
164
|
+
from kaggle.api.kaggle_api_extended import KaggleApi
|
|
165
|
+
|
|
166
|
+
api = KaggleApi()
|
|
167
|
+
api.authenticate()
|
|
168
|
+
|
|
169
|
+
# Search datasets
|
|
170
|
+
datasets = api.dataset_list(search="genomics", sort_by="updated")
|
|
171
|
+
for ds in datasets[:5]:
|
|
172
|
+
print(f"{ds.ref}: {ds.title} ({ds.size})")
|
|
173
|
+
|
|
174
|
+
# Get dataset metadata
|
|
175
|
+
metadata = api.dataset_view("nih-chest-xrays/data")
|
|
176
|
+
print(f"Title: {metadata.title}")
|
|
177
|
+
print(f"Size: {metadata.totalBytes}")
|
|
178
|
+
print(f"Description: {metadata.description[:200]}")
|
|
179
|
+
|
|
180
|
+
# Download dataset files
|
|
181
|
+
api.dataset_download_files(
|
|
182
|
+
"nih-chest-xrays/sample",
|
|
183
|
+
path="./data/chest-xrays/",
|
|
184
|
+
unzip=True
|
|
185
|
+
)
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## Common Research Patterns
|
|
189
|
+
|
|
190
|
+
**Benchmark Dataset Access:** Download well-established datasets used in published research for reproducibility studies. Kaggle hosts canonical versions of many benchmark datasets referenced in ML papers.
|
|
191
|
+
|
|
192
|
+
**Competition as Evaluation Framework:** Use Kaggle competitions as standardized evaluation environments with leaderboards and held-out test sets. Submit predictions from novel methods to compare against state-of-the-art approaches.
|
|
193
|
+
|
|
194
|
+
**Data Exploration Notebooks:** Search for and pull community notebooks that explore datasets relevant to your research. These often contain valuable preprocessing code, exploratory analysis, and baseline models.
|
|
195
|
+
|
|
196
|
+
**Collaborative Research Datasets:** Upload processed research datasets to Kaggle for sharing with collaborators and the broader community, enabling others to reproduce and extend your work.
|
|
197
|
+
|
|
198
|
+
**Cross-Domain Transfer:** Search across Kaggle's diverse dataset collection to find datasets from adjacent domains that could be useful for transfer learning or cross-domain validation studies.
|
|
199
|
+
|
|
200
|
+
## Rate Limits and Best Practices
|
|
201
|
+
|
|
202
|
+
- **API rate limits:** Kaggle imposes daily limits on API calls; typical free accounts allow several hundred requests per day
|
|
203
|
+
- **Download limits:** Large datasets may take significant time and disk space; check sizes before downloading
|
|
204
|
+
- **Competition rules:** Always accept competition rules on the Kaggle website before attempting to download competition data via API
|
|
205
|
+
- **Kernel push format:** When pushing notebooks, include a `kernel-metadata.json` file specifying the kernel type, language, and datasets
|
|
206
|
+
- **Authentication security:** Never commit `kaggle.json` to version control; use environment variables in CI/CD pipelines
|
|
207
|
+
- **Dataset versioning:** Kaggle datasets support versions; specify version numbers for reproducibility in research
|
|
208
|
+
- **Large files:** For datasets over 10GB, consider using the Kaggle CLI rather than the Python API for more reliable downloads
|
|
209
|
+
|
|
210
|
+
## References
|
|
211
|
+
|
|
212
|
+
- Kaggle API Documentation: https://www.kaggle.com/docs/api
|
|
213
|
+
- Kaggle API GitHub Repository: https://github.com/Kaggle/kaggle-api
|
|
214
|
+
- Kaggle Datasets: https://www.kaggle.com/datasets
|
|
215
|
+
- Kaggle Competitions: https://www.kaggle.com/competitions
|
|
216
|
+
- Kaggle Notebooks: https://www.kaggle.com/code
|