Skip to content

Commit

Permalink
Add feature overview docs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Merlin04 committed Jun 18, 2021
1 parent 733687f commit 040aad5
Show file tree
Hide file tree
Showing 18 changed files with 81 additions and 5 deletions.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions pages/feature-overview/block-editor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Block editor

At the heart of Kobra is its block editor (built on [Blockly](https://developers.google.com/blockly)). The block editor is used to build programs without needing to know about complicated programming language syntax.

On the left side, there is a toolbox, which holds all of the available blocks:

![Screenshot of block toolbox](/toolbox.png)

If you click on a tab, a flyout will open with the contents of it. You can then drag a block from the flyout onto the workspace.

To build a program, connect blocks to the "on run" block. Blocks will snap together when you drag them close to each other.

![Screenshot of a block connected to the on run block](/connecting-blocks.png)

To get rid of a block, you can drag it onto the trash can, drag it onto the toolbox, or right click on it and select "delete block." To restore a deleted block, click on the trash can. A panel will open with its contents.
59 changes: 59 additions & 0 deletions pages/feature-overview/dataset-uploads.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Dataset uploads

In the machine learning world, a dataset is just a collection of data, like a table or a spreadsheet. In order to get your own data into your Kobra project, you'll need to upload them.

## Export from a program

Kobra uses the industry-standard CSV format for dataset imports (we support TSV and other variants too). Most spreadsheet programs have an option to export a CSV file; here's instructions for the most popular programs.

### Google Sheets

To export a CSV file, select the sheet you want to export, then go to File -> Download -> Comma-separated values (.csv, current sheet). The file will download to your computer.

![Screenshot showing menus used to export CSV file from Google Sheets](/export-csv-google-sheets.png)

### Microsoft Excel

First, click the File tab in the upper left corner:

![Screenshot showing file menu in Microsoft Excel](/export-csv-excel-0.png)

Then, click "Save As," then select "Browse":

![Screenshot showing save as menu in Microsoft Excel](/export-csv-excel-1.png)

Then, select the "Save as type" dropdown in the resulting dialog box, then choose "CSV (Comma delimited) (*.csv)." Proceed with saving the file as you normally would.

![Screenshot showing save dialog with save as type dropdown open in Microsoft Excel](/export-csv-excel-2.png)

Excel will show a warning about possible data loss:

![Screenshot showing warning in Microsoft Excel: POSSIBLE DATA LOSS: Some features might be lost if you save this workbook in the comma-delimited (.csv) format. To preserve these features, save it in an Excel file format.](/export-csv-excel-3.png)

If you want to keep any other sheets or any formatting in your spreadsheet, click the "Save As..." button in the warning message, and save the file normally. You'll still need the CSV to upload to Kobra.

## Import into Kobra

First, click the Datasets tab in the upper left panel:

![Screenshot showing Datasets tab button](/upload-dataset-1.png)

Then, drag a file onto the panel or click the text to select a file with a dialog:

![Screenshot showing Datasets tab contents: Drop your files here! Or click here to upload](/upload-dataset-2.png)

Kobra will upload your dataset and display it in the panel. It will also open the DataFrames tab of the toolbox, showing the block that corresponds to the dataset:

![Screenshot showing full Kobra UI, with a dataset showing in the Datasets panel and the DataFrames tab of the toolbox open, with an as DataFrame block at the top in a section labeled Uploaded datasets](/upload-dataset-3.png)

You can then drag that block out to the workspace to use the data as a DataFrame.

## Editing a dataset

To edit a dataset, click the edit button next to the dataset name in the Datasets panel:

![Screenshot showing section of Datasets panel labeled Uploaded datasets with the edit button next to a dataset highlighted](/edit-dataset-1.png)

This will open a dialog with a spreadsheet-style editor. Use this to edit the dataset, then click "Save" when you are done. You can close the dialog at any time and your changes will not be saved.

![Screenshot showing dialog box titled Edit dataset with a spreadsheet widget in the middle and save and close buttons at the bottom](/edit-dataset-2.png)
4 changes: 4 additions & 0 deletions pages/feature-overview/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"block-editor": "Block editor",
"dataset-uploads": "Dataset uploads"
}
8 changes: 3 additions & 5 deletions pages/meta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"index": "Introduction",
"features": "Features",
"docs": "Docs Theme",
"blog": "Blog Theme",
"advanced": "Advanced"
}
"dataframes": "DataFrames",
"feature-overview": "Feature overview"
}
Binary file added public/connecting-blocks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/edit-dataset-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/edit-dataset-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/export-csv-excel-0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/export-csv-excel-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/export-csv-excel-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/export-csv-excel-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/export-csv-google-sheets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/toolbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/upload-dataset-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/upload-dataset-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/upload-dataset-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 040aad5

@vercel
Copy link

@vercel vercel bot commented on 040aad5 Jun 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.