Spaces:
Runtime error
Runtime error
File size: 5,696 Bytes
db5855f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
// @ts-check
import { execSync } from 'child_process';
import { docsNotebooks } from './docs-notebooks.js';
import { NotebookContentReader } from './notebook-content-reader.js';
/** @typedef {import('./notebook-content-reader.js').INotebookMetadata} INotebookMetadata */
export class NotebookMetadataCollector extends NotebookContentReader {
/**
* @private
* @returns {string}
*/
_getNotebookTitle() {
const { cells } = this._getNotebookJson();
const firstCellContent = cells[0].source.join('');
const titleRegexp = /# (?<title>.+)/g;
const match = titleRegexp.exec(firstCellContent);
if (!match || !match.groups || !match.groups.title) {
return '';
}
const markdownLinkRegExp = /\[(.+)\]\(.+\)/g;
return match.groups.title.replace(markdownLinkRegExp, (value, group) => `${group || value}`).trim();
}
/**
* @private
* @returns {string | null}
*/
_getImageUrl() {
const imageUrl = this._getMetadataFromNotebookFile('imageUrl');
return imageUrl || null;
}
/**
* @private
* @returns {string}
*/
_getNotebookCreatedDate() {
return execSync(
`git log --follow -1 --pretty=format:"%ad" --date=iso --diff-filter=AC -- ${this._absoluteNotebookPath}`
).toString();
}
/**
* @private
* @returns {string}
*/
_getNotebookModifiedDate() {
return execSync(
`git log -1 --pretty=format:"%ad" --date=iso --diff-filter=a -- ${this._absoluteNotebookPath}`
).toString();
}
/**
* @private
* @returns {string}
*/
_getNotebookGitHubLink() {
return `https://github.com/openvinotoolkit/openvino_notebooks/blob/latest/notebooks/${this._notebookFilePath}`;
}
/**
* @private
* @returns {string | null}
*/
_getDocsLink() {
const { latestDocsNotebooks, latestOVReleaseTag } = docsNotebooks;
const notebookFileName = this._notebookFileName.replace('.ipynb', '');
const docsVersion = latestOVReleaseTag.split('.').slice(0, 2)[0];
const docsUrl = `https://docs.openvino.ai/${docsVersion}/notebooks/${notebookFileName}-with-output.html`;
return latestDocsNotebooks.includes(this._notebookFilePath) ? docsUrl : null;
}
/**
* @private
* @returns {string | null}
*/
_getNotebookColabLink() {
const readmeContent = this._getReadmeContent();
const colabBadgeRegExp = new RegExp(
`\\[!\\[Colab\\]\\(.+\\)\\]\\((?<link>.+(?:${this._notebookFileName}))\\)`,
'g'
);
const match = colabBadgeRegExp.exec(readmeContent);
if (!match || !match.groups || !match.groups.link) {
return null;
}
return match.groups.link;
}
/**
* @private
* @returns {string | null}
*/
_getNotebookBinderLink() {
const readmeContent = this._getReadmeContent();
const binderBadgeRegExp = new RegExp(
`\\[!\\[Binder\\]\\(.+\\)\\]\\((?<link>.+(?:${this._notebookFileName}))\\)`,
'g'
);
const match = binderBadgeRegExp.exec(readmeContent);
if (!match || !match.groups || !match.groups.link) {
return null;
}
return match.groups.link;
}
/**
* @private
* @returns {INotebookMetadata['tags']['libraries']}
*/
_getLibrariesTags() {
const codeCells = this._getCodeCells();
const content = codeCells.map(({ source }) => source.join('\n')).join('\n');
const tags = [];
for (const [tag, patterns] of Object.entries(librariesPatterns)) {
if (patterns.some((pattern) => content.includes(pattern))) {
tags.push(tag);
}
}
return tags;
}
/**
* @private
* @returns {INotebookMetadata['tags']}
*/
_getTags() {
const tags = this._getMetadataFromNotebookFile('tags');
const libraries = this._getLibrariesTags();
return {
categories: [],
tasks: [],
other: [],
...tags,
libraries,
};
}
/**
* Collects and returns new metadata object
*
* @public
* @returns {INotebookMetadata}
*/
getMetadata() {
return {
title: this._getNotebookTitle(),
path: this._notebookFilePath,
imageUrl: this._getImageUrl(),
createdDate: this._getNotebookCreatedDate(),
modifiedDate: this._getNotebookModifiedDate() || this._getNotebookCreatedDate(),
links: {
github: this._getNotebookGitHubLink(),
docs: this._getDocsLink(),
colab: this._getNotebookColabLink(),
binder: this._getNotebookBinderLink(),
},
tags: this._getTags(),
};
}
}
/** @typedef {typeof import('../shared/notebook-tags.js').LIBRARIES_VALUES} LIBRARIES_VALUES */
/** @type {Record<LIBRARIES_VALUES[number], string[]>} */
const librariesPatterns = {
NNCF: ['import nncf', 'from nncf'],
'Model Converter': ['ov.convert_model(', 'openvino.convert_model(', '! ovc'],
'Model Server': ['import ovmsclient', 'from ovmsclient'],
'Open Model Zoo': ['omz_downloader', 'omz_converter', 'omz_info_dumper'],
'Benchmark Tool': ['benchmark_app'],
'Optimum Intel': ['import optimum.intel', 'from optimum.intel'],
Transformers: ['import transformers', 'from transformers'],
Diffusers: ['import diffusers', 'from diffusers'],
TensorFlow: ['import tensorflow', 'from tensorflow'],
'TF Lite': ['.tflite'],
PyTorch: ['import torch', 'from torch'],
ONNX: ['.onnx'],
PaddlePaddle: ['import paddle', 'from paddle'],
Ultralytics: ['import ultralytics', 'from ultralytics'],
Gradio: ['import gradio', 'from gradio'],
'OpenVINO Tokenizers': ['import openvino_tokenizers', 'from openvino_tokenizers'],
};
|