OpeNTF Tutorials

[mahdis-saeedi]

This is to collaborate on tutorial-related issues and concerns.

[mahdis-saeedi]

@hosseinfani @jamil2388
This is the link for the Jupiter notes we had in umap.
https://github.com/fani-lab/OpeNTF/tree/main/docs/tutorial/umap24/jupyter

[jamil2388]

@mahdis-saeedi Can you check if this one works?
https://github.com/fani-lab/OpeNTF/tree/7905ad34028cdec5db661a3bf8e45e158fd6e816/docs/tutorial/umap24/jupyter

[hosseinfani]

@jamil2388
https://github.com/fani-lab/OpeNTF/tree/main/docs/tutorial/umap24/jupyter

Mahdis link is correct but the actual url is not there. i fixed it.

[jamil2388]

Hi @hosseinfani,

when I cloned the OpeNTF to work on the main branch from fresh start, by default it shows this as a git status

On branch main
Your branch is up to date with 'origin/main'.

Changes not staged for commit:
(use "git add ..." to update what will be committed)
(use "git restore ..." to discard changes in working directory)
modified: docs/tutorial/umap24/jupyter/Temporal.ipynb

I see that this keeps on popping up even if I stash the changes, or add the Temporal ipynb file. Can you suggest any fix?

[hosseinfani]

@jamil2388 the reason might be because of two notebooks with same name "Temporal.ipynb" and "temporal.ipynb" Please check them if they're the same and remove one of them (see other notepads are camecase)

[jamil2388]

The duplicate file issue was solved. There two files Temporal and temporal.ipynb but in Mac and Windows systems sometimes the file system acts as case insensitive, hence the collision of same named files in the same directory. I renamed the temporal one to be discarded later. Then cloned the repo, deleted the renamed one, then pushed the changes. So Temporal.ipynb now has the relevant contents.

[jamil2388]

@hosseinfani can you please put the same settings for the contents in sigir-ap24, just like the page settings for Github Pages for hosting the umap24? I just want to see if the sigir-ap24 part works as a separate tutorial website just like the umap24. Thanks!

[hosseinfani]

@jamil2388
yes, it's working like this: https://fani-lab.github.io/OpeNTF/tutorial/sigir-ap24/
in a separate folder. do you mean this?

[jamil2388]

@hosseinfani, yes I meant that, but now it's pointing to the index.html, which is not the starting point of the umap24 I believe. Can you please check on that? Thank you!

[hosseinfani]

@jamil2388
pls check the index.html of the umap24 folder. As you see, that file is changed to load the website. You need to do similar changes to the index.html file in the sigir-ap24 folder.

github only bootstraps index.html. so, everything should be done after it.

[jamil2388]

Hi @hosseinfani, I need your help regarding this case.
I tried to test my changes through my personal github-pages settings. I duplicated the entire sigir-ap24 folder. So the progression was something like this (followed from standard procedure for react based apps just like the umap24)

• Prepare the react app locally (example : umap24, sigir-ap24 etc.)
• yarn build (this builds the app for host ready environment)
• yarn deploy (this deploys the entire react app to the gh-pages branch of the relevant repository, which makes it push all the changes to the gh-pages branch right away)
• The particular repository, (here sigir-ap24) needs to be configured in the Settings > Pages section of that relevant repository
• Now I configured the website path just like this jamil2388.github.io/test_js/ (you can consider test_js as the same folder of sigir-ap24 in your OpeNTF repo, so in your case, it had to be fani-lab.github.io/OpeNTF/tutorial/sigir-ap24/, as you maybe hosted the site starting from the docs folder, not sure though about this part)
• With the same contents as I gave to your repo, now my link properly hosts the sigir-ap24 contents. But when I did the same for the OpeNTF, it doesnt load anything other than the dummy index.html stuffs.

I think there might be any issue with the relative link of the repo. Or maybe anything else that I am yet to learn. Sorry for the unsolved case.

[jamil2388]

Hi @hosseinfani, how do we run the jupyter notebooks from the **docs/tutorials/umap24/jupyter/ folder?

Usually I prefer :

• Install the jupyter in the "opentf" virtualenvironment that we set up before running the project
• Add the opentf kernel to the installed jupyter to recognize the environment while running the notebook
• Start the notebook (and then we can activate the "opentf" kernel within the notebook)

But this approach should require us to update the requirements.txt to include jupyter installation (although it can be taken care of later)

[mahdis-saeedi]

@Lillliant
Hello Christine,
Can you please help Jamil for his issues regarding the website?
Thank you.

[hosseinfani]

Hi @jamil2388
Please see @lilizhu1 merge. It's working now. We need to update the links at the end of the page though.

@Lillliant
Would also appreciate it if you update the links to the slides and recording at the end of the umap24 page:

slides: https://www.slideshare.net/slideshow/collaborative-team-recommendation-for-skilled-users-objectives-techniques-and-new-perspectives/270130704

recording: https://www.youtube.com/playlist?list=PLKFWrqRN8VmRmxwDKlaA7Moa_Wv0li7ex

[jamil2388]

Hi @Lillliant, I saw that the changes were working on the sigir-ap24 endpoint. Now I changed some frontend contents which I tested with my local environment. I also executed
yarn build
yarn deploy
to apply the changes and push them accordingly with these commands. But unfortunately, its not working. Can you please tell me what steps I need to take to apply the changes in the actual website? thanks!

[mahdis-saeedi]

Hi @jamil2388 @Lillliant , our sigri-ap tutorial website is up now at https://www.sigir-ap.org/sigir-ap-2024/tutorial/. Can you please fix the following issues sooner?

• Top of the title, sigir-ap is linked to the umap website.

• Date and time should change to:
  9-12:15Monday (GMT+9)
  Dec. 9, 2024, Room 3
  Thanks.

[jamil2388]

@mahdis-saeedi I already changed and updated all the stuffs this morning. I just need help from @Lillliant to reflect the changes in the main website

[Lillliant]

Hi @jamil2388 and @mahdis-saeedi,

Sorry for the late replies. I don't have access to the pages settings in this repo anymore, but I believe the pages are deployed from the docs folder. gh-pages files hence will not deploy.

I've modified yarn deploy command. After running yarn install, can you let me know if website changes are reflected? @jamil2388

For Jupyter notebooks, I previously ran them in VScode with Jupyter extensions. I used conda environments previously (with OpeNTF main branch & Adila).

[jamil2388]

@Lillliant , sorry to bother you on this, but now I pulled all changes in my local, then ran yarn install, then yarn build and finally yarn deploy, but the changes aren't there reflecting in the expected link https://fani-lab.github.io/OpeNTF/tutorial/sigir-ap24/ Logically it should reflect and automatically load any changes everytime after I perform yarn build and then deploy. But I think somewhere there is a referencing issue

[hosseinfani]

@jamil2388 seems you have to modify yarn deploy as @Lillliant said

I've modified yarn deploy command

[jamil2388]

@hosseinfani I noticed the change in the deploy command. I pulled the changes into my local. Then I just tweaked some text in the website, and now I can find the changes. I will notify with bigger changes later. Thanks a lot @hosseinfani and @Lillliant !

For self note down, once I appended the ?refresh modifier to the website link (indicating to avoid cache), the website changes showed up.

Additional notes:
Later when I again changed some contents, the changes didnt show up. So I first added and pushed all the usual changes to the main branch, then performed the yarn build and yarn deploy, which resulted in applying the new changes. The new yarn deploy copies the contents of the build folder (possibly all the latest changes available within that time) and places it for the gh-pages branch (only the static contents that get generated after the build), so that the latest changes are reflected. That's why we need to first add all the updated contents in the working branch and then apply the deploy.