Difference between revisions of "Week 2"

From Research management course
Jump to: navigation, search
Line 33: Line 33:
 
# Fill the '''readme.md''' file in the github project.
 
# Fill the '''readme.md''' file in the github project.
  
 +
===Tips to your healthy repository===
 +
* GitHub: clone the '''master''' and upload your contributions to it if you are working with your own code only [https://github.com/Strijov/Strijov2018-1AutomationOfResearch/raw/master/GitHubSimplest.pdf See a short guide to  GitHub].
 +
# '''Update first''', Commit after (Pull first, Push after)
 +
# '''Your own work only''', no external publications
 +
# '''No big files''' (put link to external datasets)
 +
# '''No temporary''' nor dummy files
 +
Tell the difference [https://stackoverflow.com/questions/5009600/difference-between-fork-and-branch-on-github between '''branch''' and '''fork''']
  
 
# (If the project resumes) Create a personal folder in the project repository, title in the Surname2018Title format.
 
# (If the project resumes) Create a personal folder in the project repository, title in the Surname2018Title format.
Line 85: Line 92:
 
* Examples of rewiev-and-planning drafts LinkReview [https://docs.google.com/document/d/1fx7fVlmnwdTesElt-lbaHvoGEjJC5t_9e-X0ZpUzEcQ/edit?usp=sharing one], [https://docs.google.com/document/d/1XNhnwvooJwjj5UL6lkTio0bpvRKIj2NPVNCdHDRLOLc/edit?usp=sharing two].
 
* Examples of rewiev-and-planning drafts LinkReview [https://docs.google.com/document/d/1fx7fVlmnwdTesElt-lbaHvoGEjJC5t_9e-X0ZpUzEcQ/edit?usp=sharing one], [https://docs.google.com/document/d/1XNhnwvooJwjj5UL6lkTio0bpvRKIj2NPVNCdHDRLOLc/edit?usp=sharing two].
 
* [https://cs10.pikabu.ru/post_img/big/2018/07/10/4/1531199339121474094.jpg Демотиватор про Карлсона]
 
* [https://cs10.pikabu.ru/post_img/big/2018/07/10/4/1531199339121474094.jpg Демотиватор про Карлсона]
<!--* [[Media:CommResrarchProtocol.pdf|Методические рекомендации выполнения исследовательских проектов в коммерческой фирме]].-->
+
* [[Media:CommResrarchProtocol.pdf|Методические рекомендации выполнения исследовательских проектов в коммерческой фирме]].
 
* [https://web.stanford.edu/class/ee384m/Handouts/HowtoReadPaper.pdf How to Read a Paper, 2016, S. Keshav]
 
* [https://web.stanford.edu/class/ee384m/Handouts/HowtoReadPaper.pdf How to Read a Paper, 2016, S. Keshav]
  
===Советы по пользованию репозиторием===
+
==Homework==
* GitHub: clone the '''master''' and upload your contributions to it if you are working with your own code only [https://github.com/Strijov/Strijov2018-1AutomationOfResearch/raw/master/GitHubSimplest.pdf See a short guide to  GitHub].
+
# Select your project with your group in '''the evening of this Thursday!'''  
# '''Update first''', Commit after (Pull first, Push after)
+
# Put your project in the table
# '''Your own work only''', no external publications
+
# Land your project (it takes time)
# '''No big files''' (put link to external datasets)
+
# Put the links to your project in the group table
# '''No temporary''' nor dummy files
+
# Prepare the '''letter A''', discuss it with consultant
Tell the difference [https://stackoverflow.com/questions/5009600/difference-between-fork-and-branch-on-github between '''branch''' and '''fork''']
+
# Put it to '''read.me''' file

Revision as of 21:52, 12 February 2023

The goal of this week is to comprehend the main goal of your project and write about it.

Select your project (Spring 2022)

To select your project:

  1. Look through the list of projects.
  2. Find information about the experts and consultants.
  3. Select your projects in [1].
  4. Wait for confirmation from ...
  5. Put confirmed topics to the Group table
  6. Write your consultant (politely).

A: Abstract

Write a draft of your abstract. Think of a motivation. The abstract shall not exceed 600 characters. It may contain:

  1. wide-range field of the investigated problem,
  2. narrow problem to focus on,
  3. features and conditions of the problem,
  4. the novelty (please not exaggerate),
  5. application to illustrate with (put the results here later).

Land your project

  1. Discuss with your consultant the project goals and understand the problem statement.
  2. Find in the organization https://github.com/Intelligent-Systems-Phystech the repository of your project or create it with the title Project-N' or using the project short title, see examples.
  3. Create the folder structure:
    • docs,
    • code,
    • data,
    • [figs].
  4. Put the direct link to the paper in the Group table, so that everyone could access it.
  5. Rename article.tex to Surname2020Title.tex
  6. Check the both .tex and .pdf files are downloaded.
  7. Fill the readme.md file in the github project.

Tips to your healthy repository

  1. Update first, Commit after (Pull first, Push after)
  2. Your own work only, no external publications
  3. No big files (put link to external datasets)
  4. No temporary nor dummy files

Tell the difference between branch and fork

  1. (If the project resumes) Create a personal folder in the project repository, title in the Surname2018Title format.
  2. Place the file with the article template in a personal folder. The name is in the Surname2018Title.tex format.
    • Write a link to the PDF file with the text of the article into a Group table.
    • Tip: copy the link as the URL of the Download button of the PDF file that is in the repository.
  3. Create a draft document of the literature review in the LinkReview format and link it to the Group table .
  4. Advice. Add references to data sources, code, and libraries in LinkReview in addition to the literature.
  5. Tip: create a group chat.

L: Literature

We use the LinkReview draft format to share our evanescent ephemeral ideas and impressions we have during the literature reading.

  1. Collect the list of references including:
    1. state-of-the-art reviews, tutorials,
    2. fundamental solutions to the problem,
    3. the basic algorithm to solve your problem,
    4. alternative algorithms,
    5. [changes in the research directions],
    6. data sets and experiments,
    7. the papers that use these data sets
    8. applications of the results,
    9. names of researchers, who solve this problem,
    10. their students and teams,
    11. those, who refer to their works.
  2. Balance the list of new and well-known works.
  3. Keep up-to-date the list of keywords to search.
  4. Continuously fill your LinkReview.
  5. Plan Introduction (see the next todo list), namely collect
    • keywords as the basic termini; those who brigs good search results are useful,
    • what the paper devoted to,
    • the investigated problem,
    • the central idea,
    • literature review,
    • the authors' contribution.

B: Beginner's-talk

Short 45-second introductory talk. Plan of the talk:

  1. The project goal. What is the motivation, the goal to reach?
  2. The main idea. What is the message?
  3. The expected result. What is your delivery, your impact, novelty?

There is no time to show a slide or draw a plot on the blackboard. Instead, rehearse the report. Week 3 starts with your talk.


Resources

Homework

  1. Select your project with your group in the evening of this Thursday!
  2. Put your project in the table
  3. Land your project (it takes time)
  4. Put the links to your project in the group table
  5. Prepare the letter A, discuss it with consultant
  6. Put it to read.me file